From 71b9c7978a8129a65cc8b95346e7e2dc62fabf7f Mon Sep 17 00:00:00 2001 From: Russell Date: Wed, 10 Apr 2024 17:08:04 -0500 Subject: [PATCH] Fix an admonition example (#902) 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 --- docs/syntax/admonitions.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/syntax/admonitions.md b/docs/syntax/admonitions.md index 510c4d61..14c93b5e 100644 --- a/docs/syntax/admonitions.md +++ b/docs/syntax/admonitions.md @@ -23,13 +23,13 @@ The following core admonition types are available: These admonitions take no argument, but may be specified with options: -:class: A space-separated list of CSS classes to add to the admonition. +:class: A space-separated list of CSS classes to add to the admonition, conforming to the [identifier normalization rules](https://docutils.sourceforge.io/docs/ref/rst/directives.html#identifier-normalization). :name: A reference target for the admonition (see [cross-referencing](#syntax/referencing)). ::::{myst-example} :::{tip} -:class: myclass1,myclass2 +:class: myclass1 myclass2 :name: a-tip-reference Let's give readers a helpful hint! :::