Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fixed the error message for a user to open the crate #14969

Merged
merged 1 commit into from
Dec 19, 2024

Conversation

ibilalkayy
Copy link
Contributor

What does this PR try to resolve?

This PR is resolving an issue where cargo doc --open --examples does not give a clear message when the examples file is given to it.

I changed the message from no crates with documentation in the cargo_doc.rs and doc.rs to requested crate documentation is not available to open. Now it becomes easy for the user to understand what they're missing.

Fixes #14776

How should we test and review this PR?

Here is the command through which you can test this change:

cargo test SNAPSHOTS=overwrite -- doc::open_no_doc_crate

@rustbot
Copy link
Collaborator

rustbot commented Dec 19, 2024

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @weihanglo (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

@rustbot rustbot added Command-doc S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 19, 2024
@epage
Copy link
Contributor

epage commented Dec 19, 2024

Previously reviewed at #14957

@epage epage enabled auto-merge December 19, 2024 22:50
@epage
Copy link
Contributor

epage commented Dec 19, 2024

Thanks!

@ibilalkayy
Copy link
Contributor Author

You're welcome, Page!

@epage epage added this pull request to the merge queue Dec 19, 2024
Merged via the queue into rust-lang:master with commit efaaa0c Dec 19, 2024
20 checks passed
bors added a commit to rust-lang-ci/rust that referenced this pull request Dec 21, 2024
Update cargo

10 commits in 99dff6d77db779716dda9ca3b29c26addd02c1be..652623b779c88fe44afede28bf7f1c9c07812511
2024-12-18 00:55:17 +0000 to 2024-12-20 15:44:42 +0000
- fix(package): use relpath to cwd for vcs dirtiness report (rust-lang/cargo#14970)
- Enable triagebot merge conflict notifications (rust-lang/cargo#14972)
- fixed the error message for a user to open the crate (rust-lang/cargo#14969)
- fix(package): show dirty filepaths relative to git workdir (rust-lang/cargo#14968)
- Add the `test` cfg as a well known cfg before of compiler change (rust-lang/cargo#14963)
- refactor(cargo-package): let-else to flatten code (rust-lang/cargo#14959)
- fix(cargo-package): add more traces (rust-lang/cargo#14960)
- Do not hash absolute sysroot path into stdlib crates metadata. (rust-lang/cargo#14951)
- docs: add missing argument to Rustup Cargo workaround (rust-lang/cargo#14954)
- fix(cargo-rustc): stabilize higher precedence trailing flags (rust-lang/cargo#14900)
@rustbot rustbot added this to the 1.85.0 milestone Dec 21, 2024
@armujahid
Copy link

Thanks. for future PRs, remember that you can clean commit history and force push in your local branch instead of creating another PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Command-doc S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cargo doc --open error message is confusing when all targets are skipped
5 participants