Improve configuration-related documentation #104
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
- Separate configuration selection and description merging into separate documents and formalize "appendix" as the preferred term for supplemental, non-configuration-specific files. (This has been in use in other contexts, including CMake's implementation, but previously the specification itself did not provide a specific term for these.) This should also help the description merging documentation to be more discoverable, since, while configuration-specific files are one of the things that need merging, merging is not a sub-topic of configuration selection. - Clarify what contents are allowed in an appendix. (This information was previously missing.) Clarify meaning of `default_license` when used in an appendix. - Specify that configurations shall be treated as case insensitive. - Improve explanation of configurations and add much more extensive recommendations on how configurations should be used. - Fix minor error in multi-axis configuration example.
mwoehlke
added
the
documentation
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Separate configuration selection and description merging into separate documents and formalize "appendix" as the preferred term for supplemental, non-configuration-specific files. (This has been in use in other contexts, including CMake's implementation, but previously the specification itself did not provide a specific term for these.) This should also help the description merging documentation to be more discoverable, since, while configuration-specific files are one of the things that need merging, merging is not a sub-topic of configuration selection.
Clarify what contents are allowed in an appendix. (This information was previously missing.) Clarify meaning of
default_licensewhen used in an appendix.Specify that configurations shall be treated as case insensitive.
Improve explanation of configurations and add much more extensive recommendations on how configurations should be used.
Fix minor error in multi-axis configuration example.