Make backticks et al. consistent in the abstract spec

[johnkerl]

Context: #120

Basic copy-editing:

• Make use of backticking consistent -- it was mixed on/off even in the same sentence
• Uniformize -, --, and : to :
• Uniformize periods at ends of sentences
• Correctly spell i.e. and e.g.
• Etc.

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

[johnkerl]

@thetorpedodog @bkmartinjr ping 🙏

[bkmartinjr]

Overall looks very good, and I am greatly appreciative to @johnkerl for the work on this.

My only concern is the ability to use automated reformatting in the future, and the newly introduced use of github extensions (for list, i.e., asterisk instead of dash). If we can find and configure a single reformatter for all of our markdown, and configure it for asterisk, I'm fine with the change. Else I recommend reverting back to baseline standard markdown (which is the default for most formatters, or at least the one I use :-)).

Happy to approve as soon as we have a plan on this issue.

[johnkerl]

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

[bkmartinjr]

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

[johnkerl]

@bkmartinjr thanks!

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

• I update the wiki for this repo asking people to use it
• I update the pre-commit logic for this repo (automating it)
• Or something else?

[bkmartinjr]

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.

[bkmartinjr]

TY John!

[johnkerl]

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.

• https://github.com/single-cell-data/SOMA/wiki has been updated for the short term
• Add a CI rule to enforce prettier on *.md files #132 has been created to track for the long term

[bkmartinjr]

LGTM

[thetorpedodog]

the en dash requester has logged on

[thetorpedodog]

That said, all of these are really trivia and it is still an improvement over the existing text and formatting.