doc: also mention the full syntax for the deprecated attribute #8339
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
The other day, I wanted to apply the full form (i.e., with both a custom message and a deprecation date) in mathlib and failed to guess the correct order of these two. The attribute doc-string seemed to suggest that combining them was impossible (which was luckily false). To prevent this from re-occurring, clarify the doc-string by - mentioning that a custom message and deprecation date can be combined - what the expected order of these two is
grunweg
changed the title
|
awaiting-review |
github-actions
bot
added
the
awaiting-review
|
CC @kim-em I presume you might be interested |
github-actions
bot
added
the
toolchain-available
|
Mathlib CI status (docs):
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The other day, I wanted to apply the full form (i.e., with both a custom message and a deprecation date) in mathlib and failed to guess the correct order of these two. The attribute doc-string seemed to suggest that combining them was impossible (which was luckily false).
To prevent this from re-occurring, clarify the doc-string by