-
-
Notifications
You must be signed in to change notification settings - Fork 219
minor spelling and markdown formatting fixes #627
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
Conversation
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.
Change formatting back. Edits are fine.
output-tests/README.md
Outdated
@@ -2,15 +2,15 @@ These tests are intended to validate that implementations are correctly generati | |||
|
|||
Output was initially specified with draft 2019-09. It remained largely unchanged for draft 2020-12, but will receive an update with the next release. | |||
|
|||
***NOTE** Although the formats didn't change between 2019-09 and 2020-12, the tests are replicated for 2020-12 because the `$schema` is different and implementations may (but shouldn't) produce different output.* | |||
***NOTE*** Although the formats didn't change much between 2019-09 and 2020-12, the tests are copied for 2020-12 because the `$schema` is different and implementations may (but shouldn't) produce different output.\* |
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.
No, the formatting is correct. Bold all-caps NOTE and the entire note in italics.
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.
If you prefer, you can change to
_**NOTE** blah blah blah_
(italics denoted with _
instead)
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 formatting was not correct. If you look at the markdown version you will see that multiple paragraphs were bolded, because the wrong ending delimiter was used.
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.
I use this formatting throughout my personal markdown. I assure you, it is generally correct. Use the underscores if you want.
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.
What underscores are you talking about? The problem that I corrected here was that the asterisks were mismatched, resulting in more content being bolded than was intended. You can see it in the github preview.
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.
They're not mismatched. Three at the beginning (one for italics, two for bold), two after NOTE
(ending bold), and one at the end (ending italics).
EXAMPLE more text
***EXAMPLE** more text*
My suggestion if it's not working for you is to replace the single asterisks with underscores. So then you'd have an underscore at the beginning (for italics), two asterisks (for bold), two asterisks after NOTE
(ending bold), and an underscore at the end (ending italics).
EXAMPLE with underscores if you prefer
_**EXAMPLE** with underscores if you prefer_
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.
It's not "not working for me", but more "not rendering properly on github".
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.
How is there room to argue about this sort of thing, it seems like the kind of thing that's easy to verify, or if not, just for each to post a screenshot of what you're talking about.
Here's what I see on current main
:
That kind of formatting is "loud" to me (i.e. sticks out), which I noticed on the original PR but didn't care enough to mention, but seems to render fine (i.e. as intended, with bold NOTE and italic for the rest). So I don't see an issue personally. What are you referring to when saying it doesn't render properly? Can you show what you mean?
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.
("Sticks out" is what I was going for. It's not a quote, so block quote formatting isn't right, but it still needs to be identified as separate from, yet pertaining to, the text. It's a note, a clarification. There aren't a whole lot of options that markdown affords, so I came up with this.)
821bd91
to
88fa46a
Compare
…emoved from the tests
cac0f9c
to
f6b2324
Compare
No description provided.