diff options
| author | Clayton Coleman <ccoleman@redhat.com> | 2017-05-17 01:18:30 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2017-05-17 01:18:30 -0400 |
| commit | 5db3e2f892f552df6e450316e4da1b89f7c308d8 (patch) | |
| tree | ba5f9a0a518d4f94cfb1d5e0db0b6ced33d9a9ee | |
| parent | 9a282a223a9dd0b43a58fc078d2cb6e52f914fca (diff) | |
| parent | c2edce34ee52116a1b5c85b0125ea99b32cd123c (diff) | |
Merge pull request #624 from pmorie/bool-conventions
Document naming convention for boolean API fields
| -rw-r--r-- | contributors/devel/api-conventions.md | 2 |
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 |