Skip to content

Expand markdown snippets #1930

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

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Expand markdown snippets #1930

wants to merge 7 commits into from

Conversation

BlueDrink9
Copy link
Contributor

I'm hoping this doesn't end up stepping on the toes of efforts to migrate language specific things to snippets. These are some snippets that I expected to be there and were not

@FireChickenProductivity
Copy link
Contributor

These were not planned as part of the migration itself, so no toe stepping.

@nriley nriley marked this pull request as draft July 12, 2025 16:31
@nriley
Copy link
Collaborator

nriley commented Jul 12, 2025

From the community backlog session — it looks like you are still working on this, so I have marked it as draft. Feel free to mark as ready for review once you are done with the requested changes or let us know if you have further questions. Thanks!

@BlueDrink9
Copy link
Contributor Author

oops, had forgotten to address issues. Will finalise today!

@BlueDrink9 BlueDrink9 marked this pull request as ready for review July 12, 2025 22:57
Copy link
Collaborator

@nriley nriley left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just one comment, otherwise looks good. I don't have any problem with you putting the "r" thing in here

* [ ] $0
---

name: bold
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdown syntax is not defined as bold/italic/bold italic but just as increasingly strong forms of emphasis; perhaps something like emph[asis]/strong/very strong? Even newer definitions like GitHub Flavored Markdown don't include any definitions of how the various emphasis formats should be rendered (see https://github.github.com/gfm/#emphasis-and-strong-emphasis)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, that's an interesting note. Because intuitively, and for the purpose of saying things, I feel like most people would still refer to it as bold/italic, since that is the most common rendering fashioned by far. However, it is technically incorrect… Perhaps we just include both as options?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm OK with that if the rendering is so consistent across different Markdown flavors/renderers.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added both in case anyone uses the other as a phrase. Other than that, ready to merge?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does that actually work with a portion of a word in []? I've never tried that.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It does not. Only a-z and | is supported.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry, it was less than responsible of me to not test that. Fixed now, and tested

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants