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

[BUG] Link from Cursive::new to CursiveExt doesn't work offline. #584

Open
masklinn opened this issue May 31, 2021 · 1 comment
Open

[BUG] Link from Cursive::new to CursiveExt doesn't work offline. #584

masklinn opened this issue May 31, 2021 · 1 comment
Labels

Comments

@masklinn
Copy link

I'm not sure how to resolve this. I think the ease of getting and using documentation offline is one of the strength of Rust, but because cursive_core::Cursive::new is linking downstream it can't use "local" links, even though it's linking to a sibling crate, and will usually be generated as part of the cursive documentation & re-export.

Somewhat linked to rust-lang/rust#24305 "Pain points of reexports"
Definitely linked to rust-lang/rust#74481 "Figure out a way to link to downstream crates"

@masklinn masklinn added the bug label May 31, 2021
@gyscos
Copy link
Owner

gyscos commented Jun 2, 2021

Right, that's one of the issues with the current crate organization. As mentioned in the linked threads, one workaround would be to re-document the re-export in the cursive crate itself, but that would:

  • Prevent using use cursive_core::*;, and instead force me to import each module one by one.
  • Duplicate the documentation between the two crates, with the risk of one getting outdated or even diverging. Maybe this could be solved by instead doc-linking to a shared markdown file?
  • We can only re-document items like types, modules and free functions this way, not methods on a type.

So for now, I think hard-coding the link to docs.rs is the lesser evil.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants