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.

Sign up for GitHub

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

Jump to bottom

Warning admonition #10808

Closed
HertzDevil opened this issue Jun 10, 2021 · 1 comment · Fixed by #10898
Closed

Warning admonition #10808

HertzDevil opened this issue Jun 10, 2021 · 1 comment · Fixed by #10898
Labels
kind:feature topic:tools:docs-generator

Comments

@HertzDevil
Copy link
Contributor

When I wrote #10008 I was unaware that WARNING is not one of the docs generator's supported admonitions; it should be relatively harmless to add it. The color should probably be red like BUG and DEPRECATED.

Apart from BitArray#to_slice, there are also docs similar to warnings for Socket#linger= and the summaries of the MD5 / SHA1 types.
@straight-shoota
Copy link
Member

That sounds like a good idea. A warning is a bit stronger than a note.

This is definitely more useful than some of the other admonition keywords.

@HertzDevil HertzDevil mentioned this issue Jul 7, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind:feature topic:tools:docs-generator
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Make WARNING an admonition keyword HertzDevil/crystal
2 participants
@straight-shoota @HertzDevil