Clean up crate feature list documentation #589
Merged
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
nicholasbishop
force-pushed
the
bishop-fewer-feature-lists
branch
from
cae06bb to
10d70a1
Compare
2 tasks
nicholasbishop
force-pushed
the
bishop-fewer-feature-lists
branch
from
10d70a1 to
80101ec
Compare
phip1611
reviewed
Nov 27, 2022
|
|
||
| ## Optional features | ||
|
|
||
| This crate's features are described in [`src/lib.rs`]. |
phip1611
force-pushed
the
bishop-fewer-feature-lists
branch
from
80101ec to
31c3758
Compare
Use paragraphs instead of bullets, add `panic-on-logger-errors`, and mention `uefi-services` can be used to initialize the allocator and logger.
Link to the src/lib.rs file instead of listing out the optional features so that we don't have to worry about keeping the text in sync.
The feature lists are covered in the crate docstrings now, and the crate READMEs link to that source as well. Drop the list here so we don't have to worry about keeping them in sync.
This is covered by the uefi/uefi-services crate documention. Drop the list from here so we don't have to worry about keeping it in sync.
phip1611
force-pushed
the
bishop-fewer-feature-lists
branch
from
31c3758 to
2b0aaed
Compare
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 idea here is to just have one place where all the features are described so that we can keep the documentation up-to-date without much effort.
Checklist