Skip to content

Documentation link can go to latest published version, not latest non-pre-release version #894

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

Closed
carols10cents opened this issue Jul 21, 2017 · 1 comment
Labels
C-bug 🐞 Category: unintended, undesired behavior

Comments

@carols10cents
Copy link
Member

carols10cents commented Jul 21, 2017

Which can be confusing.

Example:

Now, we could switch to storing documentation URL as a property of the version rather than the crate, but I don't think what this crate is doing is what people normally do! If you're using docs.rs, for example, the documentation for a version won't exist until after you publish and docs.rs has a chance to build it, so the documentation link would 404 for a bit after publishing if you specified the version. Updating the version in another spot in your Cargo.toml would also be annoying.

For people hosting their own docs, I don't even know if it's common to publish beneath a version path and keep old docs around, or if people are always overwriting to the same spot. This seems like a tooling issue that perhaps cargo could help with.

Or there may be other solutions to this, or other problems associated with these solutions that I haven't thought of yet. Mostly I just want to track this for discussion.

@Turbo87
Copy link
Member

Turbo87 commented Feb 11, 2021

I believe this has been fixed. We are now loading the docs.rs metadata for the visible crate version and build the documentation link from that if necessary.

@Turbo87 Turbo87 closed this as completed Feb 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug 🐞 Category: unintended, undesired behavior
Projects
None yet
Development

No branches or pull requests

2 participants