Skip to content
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 Markdown.parse public #56818

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

matthias314
Copy link
Contributor

This has been discussed on Discourse.

I've split the PR into 3 commits:

  • one for making parse public and documenting the public methods,
  • one for renaming the non-public methods to _parse,
  • one for also making the Markdown flavors public.

This way you can more easily decide what to take and what not.

@matthias314 matthias314 changed the title make 'Markdown.parse` public make Markdown.parse public Dec 13, 2024
@@ -420,6 +420,10 @@ custom flavour of Markdown can be used, but this should generally be unnecessary
Markdown.MD
Markdown.@md_str
Markdown.@doc_str
Markdown.common
Markdown.github
Copy link
Member

Choose a reason for hiding this comment

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

I wonder how well supported this is -- I believe there have been quite many changes to Githubs flavor but no changes to the parser here. cc @mortenpi

Copy link
Contributor

Choose a reason for hiding this comment

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

Honestly, I didn't even know there were flavor options for the parser. Maybe we could try to remove the option to customize this and see if anything breaks in the ecosystem? I.e. only allow the Julia flavor going forward, which I think is the only currently documented option?

@nsajko nsajko added stdlib Julia's standard library markdown labels Dec 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
markdown stdlib Julia's standard library
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants