Adding documentation for module options #1745
Merged
Conversation
This file contains 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
samsinsane
approved these changes
Nov 5, 2021
Jarod42
reviewed
Nov 5, 2021
|
I'm unsure on what makes the website check fail. |
|
I'm looking into this. UPDATE |
|
Thanks for your help in documenting those values! 🤗 |
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.
What does this PR do?
The website currently does not fully document the module-related options for the
compileassetting. I implemented these settings in #1570. I added basic descriptions about what the individual settings do. The terms used reflect those used in the C++20 standard. I think more detailed descriptions aren't necessary, as they would probably easily branch out into a lengthy description of C++20 modules, which shouldn't be the purpose of this page.How does this PR change Premake's behavior?
In no way. It's purely documentation.
Anything else we should know?
No.
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!