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

📖 Improve the documentation around abbreviations #1729

Merged
merged 1 commit into from
Jan 6, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 14 additions & 4 deletions docs/glossaries-and-terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -213,8 +213,18 @@ The abbreviations are case-sensitive and will replace all instances[^1] in your
>
> - TLA Soup

:::{tip} Order of Abbreviations
:class: dropdown
### Order of Abbreviations

Abbreviations defined in your frontmatter are applied in longest-sorted order. If you have two abbreviations with the same suffix (e.g. `RHR` and `HR`), the longer abbreviation will always take precedence.
To have the longer abbreviations not be transformed, explicitly set them to `null` in your frontmatter (e.g. `RHR: null`).
:::
To have longer abbreviations **not** be transformed, or if that string is included in another word, explicitly set them to `null` in your frontmatter. In the following example, `HTML` will not have the letters `ML` as an abbreviation.

```{myst}

---
abbreviations:
ML: Machine Learning
HTML: null
---

We use ML to parse HTML.
```
Loading