single-cell-data / SOMA

A flexible and extensible API for annotated 2D matrix data stored in multiple underlying formats.
MIT License
69 stars 9 forks source link

Make backticks et al. consistent in the abstract spec #127

Closed johnkerl closed 1 year ago

johnkerl commented 1 year ago

Context: #120

Basic copy-editing:

Reviewer-friendly rendering: https://github.com/single-cell-data/SOMA/blob/kerl/backticks-et-al/abstract_specification.md

johnkerl commented 1 year ago

@thetorpedodog @bkmartinjr ping 🙏

johnkerl commented 1 year ago

@bkmartinjr on my commits after your feedback I ran prettier abstract_specification.md and, as noted, reverted * bullets to - bullets.

bkmartinjr commented 1 year ago

@johnkerl - lets codify the formatting conventions (i.e., we use "tool X" with "Y config" somewhere).

johnkerl commented 1 year ago

@bkmartinjr thanks!

What does "codify" mean to you in terms of an actionable step?

bkmartinjr commented 1 year ago

What does "codify" mean to you in terms of an actionable step?

Ideally we should have a CI check it. But that is nice-to-have. I'd settle for "write it down in a conventions doc" for now, and we can CI stuff like this at a later date.

johnkerl commented 1 year ago

Ideally we should have a CI check it. But that is nice-to-have. I'd settle for "write it down in a conventions doc" for now, and we can CI stuff like this at a later date.