ga4gh / ga4gh-schemas

Models and APIs for Genomic data. RETIRED 2018-01-24
http://ga4gh.org
Apache License 2.0
214 stars 114 forks source link

Convert documentation to snake case #703

Open david4096 opened 8 years ago

david4096 commented 8 years ago

Currently, the documentation has snake cased fields in the .proto according to the protocol buffers style guide. Then, in the documentation .rst files, the same fields are camelCased. The Avro had originally been in camel case, and the signatures of fields have been left that way throughout the API. The serialized JSON that results from the protocol buffers messages is camel cased, and so this split has been maintained.

However, we ought to change the camelCased fields to snake case to improve consistency of the documentation, while the details of JSON serialization are covered in the appendix. @mbaudis