Style warnings using admonition in documentation #9844
Merged
+19
−8
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
browniebroke
commented
Dec 9, 2025
| --- | ||
|
|
||
| **Warning**: If you require cross-domain AJAX requests, you should generally be using the more modern approach of [CORS][cors] as an alternative to `JSONP`. See the [CORS documentation][cors-docs] for more details. | ||
| !!! warning |
browniebroke
commented
Dec 9, 2025
|
|
||
| **Warning**: Always use Django's standard login view when creating login pages. This will ensure your login views are properly protected. | ||
| !!! warning | ||
| Always use Django's standard login view when creating login pages. This will ensure your login views are properly protected. |
browniebroke
commented
Dec 9, 2025
|
|
||
| **Warning**: Do not use `.as_view()` with `@action` methods. It bypasses router setup and may ignore action settings like `permission_classes`. Use `DefaultRouter` for actions. | ||
| !!! warning | ||
| Do not use `.as_view()` with `@action` methods. It bypasses router setup and may ignore action settings like `permission_classes`. Use `DefaultRouter` for actions. |
Member
Author
|
There are 19 similar occurrences of |
auvipy
approved these changes
Dec 9, 2025
This was referenced Dec 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Use admonition markdown extension to improve callout for warnings in our docs. The extension was already installed but warnings weren't styled.
Why?
This came up in #9823, where the warning was initially added with a slightly different syntax that our existing ones. Also, I think it doesn't stand out very much in the page: