kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Document naming convention for boolean API fields

This commit is contained in:
Paul Morie 2017-05-15 16:41:57 -04:00
parent 9cb632d41f
commit c2edce34ee
1 changed files with 2 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
contributors/devel/api-conventions.md
View File

@ -1138,6 +1138,8 @@ be called `fooName`. The name of a field referring to another resource of kind
`Foo` by ObjectReference (or subset thereof) should be called `fooRef`. `Foo` by ObjectReference (or subset thereof) should be called `fooRef`.
* More generally, include the units and/or type in the field name if they could * More generally, include the units and/or type in the field name if they could
be ambiguous and they are not specified by the value or value type. be ambiguous and they are not specified by the value or value type.
* The name of a field expressing a boolean property called 'fooable' should be
called `Fooable`, not `IsFooable`.
## Label, selector, and annotation conventions ## Label, selector, and annotation conventions