[Docutils-develop] [docutils:bugs] #453 [DOC] generic "admonition" directive also listed as specific

[Günter M. <mi...@us...>]

Thank you for reporting. You found a documentation bug.
Could you check, if the changes in [r9112] help to avoid the confusion?

Docutils uses the term "admonition" in the sense of "safety message" or "hazard statement", not as reprimand or rebuke. (The German translation in parsers/rst/languages/de.py got this wrong.
A possible German translation may be "Warnhinweis" but the overlap of the semantics of the specific admonitions makes translation very tricky.)


---

** [bugs:#453] [DOC] generic "admonition" directive also listed as specific**

**Status:** open
**Created:** Wed Jul 27, 2022 09:53 AM UTC by jfbu
**Last Updated:** Wed Jul 27, 2022 09:53 AM UTC
**Owner:** nobody


I quite probably miss something obvious but [admonition directives documentation](https://docutils.sourceforge.io/docs/ref/rst/directives.html#admonitions) is not clear in so far as it lists "admonition" as a specific admonition type then describes it as being a generic type (which requires a title).


---

Sent from sourceforge.net because doc...@li... is subscribed to https://sourceforge.net/p/docutils/bugs/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/bugs/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.