[GitHub] [beam] lostluck commented on a change in pull request #17138: fixes static checks and go lint issues in Go SDK

[GitBox <gi...@apache.org>]

lostluck commented on a change in pull request #17138:
URL: https://github.com/apache/beam/pull/17138#discussion_r831287432



##########
File path: sdks/go/test/integration/primitives/cogbk.go
##########
@@ -13,6 +13,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Package primitives contains integration tests for primitives in beam.

Review comment:
       No action required, just a comment on package documentation approaches.
   
   In packages where there's no clear "good" place to put the package comment (eg a file that matches the package name etc, a common utility, entry point, etc) the alphabetically first file is a fine place to put the package comment. Especially when the comment is very small, like is appropriate for this package.
   
   If we wanted a more elaborate package comment, we would create a doc.go file which is where it would live (we do this for the beam package), so it's easier to find, and won't crowd out any specific code in the same file. Since the comment here doesn't need to be large, this isn't necessary here.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: github-unsubscribe@beam.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org