readme: do not ask for section numbers in godoc

This commit is contained in:
mxmCherry
2022-05-19 16:15:51 +03:00
committed by GitHub
parent 2bc9db4ce0
commit 10106af2f1
+1 -1
View File
@@ -68,7 +68,7 @@ Using both pointer and `omitempty` is mostly just to save traffic / generate mor
## Documentation ([pkg.go.dev](https://pkg.go.dev/github.com/mxmCherry/openrtb/v16))
- [Godoc: documenting Go code](http://blog.golang.org/godoc-documenting-go-code)
- Each entity (type, struct key or constant) should be documented
- Comments for entities should be copy-pasted "as-is" from OpenRTB specification (except section 5 - replace "table" with "list" there; ideally, each sentence must be on a new line)
- Ideally, copy-paste descriptions as-is, but feel free to omit section numbers, so just `<GoTypeName> defines <copy-pasted description from spec>`
## Code organization
- Each RTB type should be kept in its own file, named after type