Build docs.rs documentation with features enabled and other fixes #170
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
00xc
requested review from
alxiord,
sameo,
rbradford,
roypat,
andreitraistaru and
JonathanWoollett-Light
as code owners
The current documentation build in docs.rs does not include non-default crate features (at the moment just "bzimage"), which might lead to users of the crate not being aware of their existence. Signed-off-by: Carlos López <carlos.lopez@suse.com>
Fix several rustdoc bare URL warnings in the generated documentation. See-also: https://doc.rust-lang.org/rustdoc/lints.html#bare_urls Signed-off-by: Carlos López <carlos.lopez@suse.com>
Several documentation items were enclosed in angle brackets, which would cause rustdoc to interpret them as HTML tags, generating incorrect documentation. Enclose these in backticks for clarity. While we are at it, fix list formatting for said items. See-also: https://doc.rust-lang.org/rustdoc/lints.html#invalid_html_tags Signed-off-by: Carlos López <carlos.lopez@suse.com>
roypat
approved these changes
Nov 13, 2023
andreeaflorescu
approved these changes
Nov 14, 2023
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.
Summary of the PR
Requirements
Before submitting your PR, please make sure you addressed the following
requirements:
git commit -s), and the commitmessage has max 60 characters for the summary and max 75 characters for each
description line.
N/AAll added/changed functionality has a corresponding unit/integrationtest.
Release" section of CHANGELOG.md (if no such section exists, please create one).
N/AAny newly addedunsafecode is properly documented.