executablebooks / MyST-Parser

An extended commonmark compliant parser, with bridges to docutils/sphinx
https://myst-parser.readthedocs.io
MIT License
708 stars 189 forks source link

📚 DOCS: Fix admonition example #904

Closed 72757373656c6c closed 3 months ago

72757373656c6c commented 3 months ago

Correct admonition example to match class option definition which is a space-separated list.

Add a link to the class option definition for identifier normalization rules.

https://docutils.sourceforge.io/docs/ref/rst/directives.html#identifier-normalization

welcome[bot] commented 3 months ago

Thanks for submitting your first pull request! You are awesome! :hugs:
If you haven't done so already, check out EBP's Code of Conduct and our Contributing Guide, as this will greatly help the review process.
Welcome to the EBP community! :tada:

codecov-commenter commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 90.07%. Comparing base (10c2003) to head (225b8e7).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #904 +/- ## ======================================= Coverage 90.07% 90.07% ======================================= Files 24 24 Lines 3405 3405 ======================================= Hits 3067 3067 Misses 338 338 ``` | [Flag](https://app.codecov.io/gh/executablebooks/MyST-Parser/pull/904/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks) | Coverage Δ | | |---|---|---| | [pytests](https://app.codecov.io/gh/executablebooks/MyST-Parser/pull/904/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks) | `90.07% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=executablebooks#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.