Improve documentation of feature flags #887
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
x11rb has some explanation of its feature flags on its main documentation page. This commit improves this to explicitly say which "X11 extensions that are needed internally" are always enabled. Additionally, some unnecessary "crate::" at the beginning of links is removed. Then, a similar documentation is added to x11rb-protocol and x11rb-async. Signed-off-by: Uli Schlachter <[email protected]>
Codecov ReportAll modified lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #887 +/- ##
==========================================
+ Coverage 12.75% 12.89% +0.13%
==========================================
Files 189 189
Lines 138232 138430 +198
==========================================
+ Hits 17635 17847 +212
+ Misses 120597 120583 -14
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
|
Merging based on the textual approve above. |
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.
x11rb has some explanation of its feature flags on its main documentation page. This commit improves this to explicitly say which "X11 extensions that are needed internally" are always enabled. Additionally, some unnecessary "crate::" at the beginning of links is removed.
Then, a similar documentation is added to x11rb-protocol and x11rb-async.