ga4gh-beacon / specification-v2

GA4GH Beacon v2 specification.
Apache License 2.0
3 stars 6 forks source link

YAML formatting #2

Closed mbaudis closed 4 years ago

mbaudis commented 4 years ago

I have suggestions for the formatting of the spec file:

  1. using a consistent style for descriptions; I recommend always to use the multi-line format (with the sole exception of single word comments).
  2. Use Markdown style to structure multi-line descriptions:
        start:
          description: |
            Precise or fuzzy start coordinate position(s), allele locus (0-based, inclusive).
            * start only:
              - for single positions, e.g. the start of a specified sequence
              alteration where the size is given through the specified
              alternateBases
            * `start` and `end`:
    ...
  3. follow the Google code documentation style & break lines in comments at 80 chars
sdelatorrep commented 4 years ago

+1

jrambla commented 4 years ago

Can we close the issue or there is anything pending to be done?

jrambla commented 4 years ago

As noone is objecting I'll consider this issue "solved".