search

MNSignalProcessing / BarelyML

Markup display for JUCE - Barely a Markup Language
MIT License
12 stars 2 forks source link

Mispelled "Annotations" as "Admonitions" #1

Closed reFX-Mike closed 10 months ago

reFX-Mike commented 11 months ago

Annotations: a note of explanation or comment added to a text or diagram.

Admonition: an act or action of admonishing; authoritative counsel or warning. warn or reprimand someone firmly.

I don't think you meant to use "Admonitions"

MNSignalProcessing commented 10 months ago

No, it's not misspelled. That's the exact same term they use in the AsciiDoc Documentation (which has inspired this BarelyML feature): https://docs.asciidoctor.org/asciidoc/latest/syntax-quick-reference/#admonitions

I was skeptical in the beginning, too, as I was mainly aware of meanings of the word "admonition" going in the direction of "reprimand". But then I looked it up in a dictionary and it turns out that it can also mean "advice" or "memento", so I think "admonition" is actually a reasonable term to encompass hints, infos, warnings, etc.