Documentation ¶
Overview ¶
Package documentfunctions implements a linter that forces you to document functions.
When you are dealing with code that requires multiple people to collaborate, your code is not going to be "immediately obvious based on the implementation". You need to document all functions that you make. This can help find untested invariants that can lead to customers having a bad time.
To disable this behavior, document your code.
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var Analyzer = &analysis.Analyzer{
Name: "documentfunctions",
Doc: "Prevent the use of time.Sleep in test functions",
Run: run,
}
Functions ¶
This section is empty.
Types ¶
This section is empty.
Click to show internal directories.
Click to hide internal directories.