Skip to content

Commit

Permalink
doc.go: Move package after package comment
Browse files Browse the repository at this point in the history
This detailed package comment is not being recognized by Go as a
package comment because it needs to come immediately before the
package statement. This should make this comment appear on
pkg.go.dev. Fixes staticcheck warnings:

doc.go:1:1: at least one file in a package should have a package comment (ST1000)
  • Loading branch information
evanj committed Jun 5, 2024
1 parent 7ca0df4 commit c87374b
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions doc.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
package molecule

// Package molecule is a Go library for parsing and encoding protobufs in an
// efficient and zero-allocation manner, progressively consuming or creating
// the encoded bytes in a streaming fashion instead of (un)marhsaling full
Expand Down Expand Up @@ -43,3 +41,4 @@ package molecule
// examples for details.
//
// Note that most methods will do nothing when given their zero value.
package molecule

0 comments on commit c87374b

Please sign in to comment.