feat(doc): Print the generated docs links #12859
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
I've wanted something like this myself. I dislike using `--open` because I tend to move up to re-run my `cargo doc` run but then have to edit it to remove `--open`. Also makes it annoying when opening docs when `cargo doc` is wrapped by a tool like `make`. This was previously attempted in rust-lang#5592: - Unlike the request in rust-lang#5562, this aligns with rust-lang#5592 in always printing rather than using a flag as this seems generally useful - Unlike rust-lang#5592, this prints as an alternative to "Opening" to keep things light - Unlike rust-lang#5592, this prints afterwards as the link is only valid then Fixes rust-lang#5562
|
r? @weihanglo (rustbot has picked a reviewer for you, use r? to override) |
rustbot
added
A-testing-cargo-itself
epage
force-pushed
the
doc-open
branch
4 times, most recently
from
8ce21bc to
1dac61e
Compare
epage
force-pushed
the
doc-open
branch
2 times, most recently
from
958406c to
9261a81
Compare
epage
force-pushed
the
doc-open
branch
2 times, most recently
from
ee1f132 to
293f225
Compare
weihanglo
approved these changes
Oct 27, 2023
There was a problem hiding this comment.
This looks great. Have you consider integrating something like hyperlinks in terminal emulators?
ripgrep just got a similar feature, though not by using OSC escape sequence:
|
We'd also want to do that for How about we do that in a follow up? |
|
Yeah, reading that further, seems like we should have a dedicated issue for planning and implementing it |
|
Fair. Thank you @bors r+ |
bors
added
S-waiting-on-bors
|
☀️ Test successful - checks-actions |
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Oct 28, 2023
Update cargo 8 commits in df3509237935f9418351b77803df7bc05c009b3d..708383d620e183a9ece69b8fe930c411d83dee27 2023-10-24 23:09:01 +0000 to 2023-10-27 21:09:26 +0000 - feat(doc): Print the generated docs links (rust-lang/cargo#12859) - feat(toml): Allow version-less manifests (rust-lang/cargo#12786) - Remove outdated option to `-Zcheck-cfg` warnings (rust-lang/cargo#12884) - Remove duplicate binaries during install (rust-lang/cargo#12868) - refactor(shell): Write at once rather than in fragments (rust-lang/cargo#12880) - docs(ref): Link to docs.rs metadata table (rust-lang/cargo#12879) - docs(contrib): Describe how to add a new package (rust-lang/cargo#12878) - move up looking at index summary enum (rust-lang/cargo#12749) r? ghost
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.
I've wanted something like this myself. I dislike using
--openbecause I tend to move up to re-run mycargo docrun but then have to edit it to remove--open.Also makes it annoying when opening docs when
cargo docis wrapped by a tool likemake.This was previously attempted in #5592:
Fixes #5562