From 10106af2f1dd623e70c629c7f7c1a6f852a184e2 Mon Sep 17 00:00:00 2001 From: mxmCherry Date: Thu, 19 May 2022 16:15:51 +0300 Subject: [PATCH] readme: do not ask for section numbers in godoc --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3bf1eff..2c75224 100644 --- a/README.md +++ b/README.md @@ -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 ` defines ` ## Code organization - Each RTB type should be kept in its own file, named after type