summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPaul Morie <pmorie@redhat.com>2017-05-15 16:41:57 -0400
committerPaul Morie <pmorie@redhat.com>2017-05-15 16:41:57 -0400
commitc2edce34ee52116a1b5c85b0125ea99b32cd123c (patch)
treedfff4a3d63e5752ede8ea385c5a58644385e16f0
parent9cb632d41f93014b89bc5cdca0ed2575350c9fe7 (diff)
Document naming convention for boolean API fields
-rw-r--r--contributors/devel/api-conventions.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/contributors/devel/api-conventions.md b/contributors/devel/api-conventions.md
index 2a935e64..db19691e 100644
--- a/contributors/devel/api-conventions.md
+++ b/contributors/devel/api-conventions.md
@@ -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`.
* 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.
+* The name of a field expressing a boolean property called 'fooable' should be
+called `Fooable`, not `IsFooable`.
## Label, selector, and annotation conventions