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

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

Closed
dbitouze opened this issue Sep 13, 2023 · 1 comment · Fixed by #904
Closed

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

dbitouze opened this issue Sep 13, 2023 · 1 comment · Fixed by #904
Labels
documentation Improvements or additions to documentation

Comments

@dbitouze
Copy link

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.

@dbitouze dbitouze added the documentation Improvements or additions to documentation label Sep 13, 2023
@chrisjsewell
Copy link
Member

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

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

Successfully merging a pull request may close this issue.

2 participants