Skip to content

style: hints and tips#182

Open
medubelko wants to merge 5 commits intocanonical:mainfrom
medubelko:docpr-2144-hint-tip-admonitions
Open

style: hints and tips#182
medubelko wants to merge 5 commits intocanonical:mainfrom
medubelko:docpr-2144-hint-tip-admonitions

Conversation

@medubelko
Copy link
Contributor

Resolves #144.

Comment on lines +11 to +12
- '```{hint}'
- '```{tip}'
Copy link
Contributor

@SecondSkoll SecondSkoll Mar 3, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- '```{hint}'
- '```{tip}'
- '(```|:::) ?{hint}'
- '(```|:::) ?{tip}'

Theoretically you can have an unlimited number of spaces between the delimiters and the admonition/directive indicator (though I more commonly just see a single space), and we probably want to capture colon-fenced blocks as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@medubelko medubelko requested a review from dwilding March 6, 2026 18:04
Copy link
Contributor

@dwilding dwilding left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good - I like the addition of "regular paragraph"

@medubelko medubelko requested a review from SecondSkoll March 7, 2026 00:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create rule: Flag hint and tip admonitions

3 participants