-
Notifications
You must be signed in to change notification settings - Fork 10
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Make backticks et al. consistent in the abstract spec #127
Conversation
4c91567
to
3c9213b
Compare
3c9213b
to
def0e40
Compare
@thetorpedodog @bkmartinjr ping 🙏 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
@bkmartinjr on my commits after your feedback I ran |
@johnkerl - lets codify the formatting conventions (i.e., we use "tool X" with "Y config" somewhere). |
@bkmartinjr thanks! 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TY John!
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
086d482
to
01c04e8
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the en dash requester has logged on
30803c7
to
92ded55
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That said, all of these are really trivia and it is still an improvement over the existing text and formatting.
Context: #120
Basic copy-editing:
-
,--
, and:
to:
Reviewer-friendly rendering:
https://github.com/single-cell-data/SOMA/blob/kerl/backticks-et-al/abstract_specification.md