Skip to content

Commit cfd724a

Browse files
committed
Add doc comment for exported variable
golint imposes the important requirement that all exported API components have a doc comment. From a purely technical sense, there is no reason for the developer to have exported AppVersion, since it is not used in other packages of the project and the project is exclusively a standalone application; not a reusable package. However, there is maybe a little bit of semantic sense to exporting AppVersion. The deploy.sh script uses this line of the code, so in a way it is "exported", even though it is used in an janky manner that does not care anything about Go's export framework. So the export may communicate that this line is an "API" of sorts and that modifying it must be done with care.
1 parent 27020dd commit cfd724a

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

main.go

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ import (
1717
"time"
1818
)
1919

20+
// AppVersion is the application version.
2021
const AppVersion = "1.3.0"
2122

2223
var compileInfo string

0 commit comments

Comments
 (0)