-
-
Notifications
You must be signed in to change notification settings - Fork 554
linked-list: use tildes for admonition, not backticks #2255
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
From the Exercism Markdown specification [1]: We support special types of blocks that can be added to documents to pull out commentary that doesn't fit with the main body of the text. [...] All blocks are written using 4 tildes, in the form of: ~~~~exercism/note Content goes here You can include code: ```ruby str = "Hello, World" ``` ~~~~ (Note: You may also use backticks or other levels of tildes in exceptional circumstances) [1] https://github.com/exercism/docs/blob/8c604214c423/building/markdown/markdown.md#special-blocks-sometimes-called-admonitions
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.
Ugh, I thought I had fixed all these, and somehow missed this one. Thanks for fixing it.
If we don't add the prettier ignore thing, every place this is merged with formatting on or copied, it will break 💔 |
I didn't understand this. Is there something that blocks merging? Please expand. |
If you use prettier to auto-format things (and many tracks have this in place via a special command/comment), it will re-fomat the tildas ( We probably should adjust our documentation as well to point that out to folx who also use prettier locally. I know there have been multiple instances on the Python track where someone has used prettier and I've had to make them go back and re-do the edited to add: Conversely, we can change the way we do this and use backticks for admonitions. But I think we chose tildas for parsing reasons. |
My understanding is that we can merge this. This PR just brings us back to the status quo: all 9 other admonitions in this repo use tildes.
Can the track make prettier ignore files that are synced from prob-specs? |
Commit d48e19a added an admonition that used backticks, but every other admonition uses tildes.
From the Exercism Markdown specification:
With this PR, every admonition uses tildes: