xtask: Add --unstable option to cargo xtask doc
#673
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-doc-unstable
branch
from
c1fada6 to
954914b
Compare
In preparation for testing on stable, make the `unstable` feature optional when building docs. This exposed a couple docstrings with links that broke without the `unstable` feature. Fixed by changing `File::get_boxed_info` to have the same docstring as `get_boxed_info_in`, `Directory::read_entry_boxed` to have (almost) the same docstring as `read_entry_boxed_in`, and adding full URLs for some links in `make_boxed`. The CI doc job now runs with and without `--unstable`.
phip1611
force-pushed
the
bishop-doc-unstable
branch
from
954914b to
cae8883
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.
In preparation for testing on stable, make the
unstablefeature optional when building docs.This exposed a couple docstrings with links that broke without the
unstablefeature. Fixed by changingFile::get_boxed_infoto have the same docstring asget_boxed_info_in,Directory::read_entry_boxedto have (almost) the same docstring asread_entry_boxed_in, and adding full URLs for some links inmake_boxed.The CI doc job now runs with and without
--unstable.Checklist