Skip to content

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

@dbitouze

Description

@dbitouze

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions