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

docs.rs/clap/4.1.9 is broken, missing Command struct documentation #4766

Closed
2 tasks done
AndASM opened this issue Mar 17, 2023 · 5 comments
Closed
2 tasks done

docs.rs/clap/4.1.9 is broken, missing Command struct documentation #4766

AndASM opened this issue Mar 17, 2023 · 5 comments
Labels
C-bug Category: Updating dependencies

Comments

@AndASM
Copy link

AndASM commented Mar 17, 2023

Please complete the following tasks

Rust Version

any

Clap Version

4.1.9

Minimal reproducible code

Open https://docs.rs/clap/4.1.9/clap/all.html

Steps to reproduce the bug with the above code

  1. Open https://docs.rs/clap/4.1.9/clap/all.html
  2. Look for the Command struct
  3. Look at https://docs.rs/clap/4.1.8/clap/struct.Command.html for comparison

Actual Behaviour

The documentation is missing the core structures and methods for the library's functionality.

Expected Behaviour

The core methods of the library providing it's basic features are documented.

Additional Context

No response

Debug Output

No response

@AndASM AndASM added the C-bug Category: Updating dependencies label Mar 17, 2023
@epage
Copy link
Member

epage commented Mar 17, 2023

Nothing related to this change: https://diff.rs/clap/4.1.8/4.1.9/Cargo.toml

I'm guessing this is a rustdoc bug seeing as docs.rs builds using a nightly

  • ✅ rustc 1.70.0-nightly (900c35403 2023-03-08)
  • ❗ rustc 1.70.0-nightly (ab654863c 2023-03-15)
  • ❗ +nightly-2023-03-11
  • ✅ +nightly-2023-03-10

Looks like it broke on the 11th

@AndASM
Copy link
Author

AndASM commented Mar 17, 2023

Do you know who, how, or where to report that or determine that? I'm newer to Rust and early enough in the learning curve that I get lost and overloaded a bit easy.

@epage
Copy link
Member

epage commented Mar 17, 2023

I've reached out to the rustdoc team to see if this was already known (I suspect so).

My first step for this was to look through rust-lang/rust issues and PRs in case it was previously reported (at least I think rustdoc lives there)

@epage
Copy link
Member

epage commented Mar 17, 2023

Upstream issue: rust-lang/rust#109258

Upstream PR: rust-lang/rust#109259

@epage
Copy link
Member

epage commented Mar 24, 2023

Looks like its fixed now

@epage epage closed this as completed Mar 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: Updating dependencies
Projects
None yet
Development

No branches or pull requests

2 participants