Skip to content

Commit

Permalink
Merge pull request #22 from openownership/rhiaro-21-codelists
Browse files Browse the repository at this point in the history
style guide: update capitalisation guidence for codelists, fixes #21
  • Loading branch information
kd-ods committed Mar 29, 2021
2 parents 2cdd6df + a47a224 commit b396c95
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions style_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ This style guide is a draft to be discussed and not yet implemented across the B

- Object and property names, and definition entry names to be camelCase, e.g. interestedParty

- Object and property titles: first word to be uppper case. E.g. 'Interest' or 'Ownership-or-control statement'.
- Object and property titles: first word to be upper case. E.g. 'Interest' or 'Ownership-or-control statement'.

- In descriptions, properties should be referred to by their property name in backquotes. E.g. \`id\` is required.

**WIP notes**
- Codelists codes to be lowercase when single words, or camelCase when multiple words.

*Codelist codes? Currently most multi-word codes are camelCase (e.g. placeOfBirth). However in the unspecifiedReason and interestType codelists - and poss others - hyphens are used (e.g. information-unknown-to-publisher). We need to introduce some consistency.*
**WIP notes**

*Adapt and adopt [OCDS style guidance for property descriptions](https://ocds-standard-development-handbook.readthedocs.io/en/latest/meta/schema_style_guide.html#field-and-code-descriptions) ?*

Expand Down

0 comments on commit b396c95

Please sign in to comment.