Use admonitions in documentation for things marked as deprecated#1959
Merged
samsinsane merged 1 commit intopremake:masterfrom Sep 19, 2022
Merged
Use admonitions in documentation for things marked as deprecated#1959samsinsane merged 1 commit intopremake:masterfrom
samsinsane merged 1 commit intopremake:masterfrom
Conversation
samsinsane
approved these changes
Sep 19, 2022
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
What does this PR do?
Wraps deprecation notices in caution admonitions and moves them to the top for clarity.
When individual items in a table have been deprecated, those items are extracted to a table below with a caution admonition above. IMHO this makes it less likely someone will neglect to fully read the documentation and end up using a deprecated parameter.
How does this PR change Premake's behavior?
No, just documentation.
Anything else we should know?
Follow on from suggestions made during #1954
Did you check all the boxes?
closes #XXXXin comment to auto-close issue when PR is merged)You can now support Premake on our OpenCollective. Your contributions help us spend more time responding to requests like these!