github/kubernetes
1
0
Fork 0
mirror of https://github.com/k3s-io/kubernetes.git synced 2025-07-30 23:15:14 +00:00
Code Issues Projects Releases Wiki Activity

Add note about type comments to API changes doc

Browse Source
This commit is contained in:
Paul Morie 2015-12-14 15:03:21 -05:00
parent 775369a8f1
commit 90df71e5a5
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/devel/api_changes.md
View File

@ -320,7 +320,8 @@ before starting "all the rest".
The struct definitions for each API are in `pkg/api/<version>/types.go`. Edit
those files to reflect the change you want to make. Note that all types and non-inline
fields in versioned APIs must be preceded by descriptive comments - these are used to generate
documentation.
documentation. Comments for types should not contain the type name; API documentation is
generated from these comments and end-users should not be exposed to golang type names.
Optional fields should have the `,omitempty` json tag; fields are interpreted as being
required otherwise.