executablebooks / MyST-Parser

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

Amonitions `class` option value: space- or comma-separated list? #809

Closed dbitouze closed 6 months ago

dbitouze commented 1 year ago

Describe the gap in the current documentation

The “Admonition types” section reads:

These admonitions take no argument, but may be specified with options:

class: A space-separated list of CSS classes to add to the admonition.

but, in the syntax just below, the value of this class option is a comma-separated list:

:::{tip}
:class: myclass1,myclass2
:name: a-tip-reference
Let's give readers a helpful hint!
:::

[Reference to my tip](#a-tip-reference)

Describe the solution you'd like

Make the wording and the syntax consistent.

chrisjsewell commented 1 year ago

Yep just double checked and it should be space separated: https://docutils.sourceforge.io/docs/ref/rst/directives.html#class-1