Skip to content

documentation field is being ignored #1485

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
japaric opened this issue Sep 7, 2018 · 1 comment
Closed

documentation field is being ignored #1485

japaric opened this issue Sep 7, 2018 · 1 comment

Comments

@japaric
Copy link
Member

japaric commented Sep 7, 2018

For example: https://crates.io/crates/cortex-m-rt/0.6.1

The documentation link at the top left points to https://docs.rs/cortex-m-rt (which currently says "The requested resource does not exist") even though the documentation field of Cargo.toml is set to https://rust-embedded.github.io/cortex-m-rt/

$ cargo clone cortex-m-rt --vers 0.6.1

$ grep documentation cortex-m-rt/Cargo.toml
documentation = "https://rust-embedded.github.io/cortex-m-rt/"

https://crates.io/crates/cortex-m-quickstart/0.3.4 doesn't have this problem.

@carols10cents any idea what could be wrong here?

bors bot added a commit to rust-embedded/cortex-m-rt that referenced this issue Sep 7, 2018
108: README: update the documentation link r=therealprof a=japaric

because we have `readme = "README.md"` set in Cargo.toml the crates.io page
renders the README which contains a BIG "Documentation" link that points to
docs.rs which is broken. This commit makes that link point to our GH page.

r? @rust-embedded/cortex-m (anyone)

I have also observed that the smaller "documentation" link in the crates.io page
is ignoring the "documentation" field and pointing to docs.rs. I reported this
as a bug in rust-lang/crates.io#1485

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
@sgrif
Copy link
Contributor

sgrif commented Sep 7, 2018

The most recent version you uploaded is 0.5.4, which had the displayed value in its documentation field in Cargo.toml. Closing as a duplicate of #1389

As a side note, it's rather rude to ping individual contributors when opening an issue, rather than letting them deal with it when they see the open issue.

@sgrif sgrif closed this as completed Sep 7, 2018
adamgreig pushed a commit to rust-embedded/cortex-m that referenced this issue Jan 12, 2022
108: README: update the documentation link r=therealprof a=japaric

because we have `readme = "README.md"` set in Cargo.toml the crates.io page
renders the README which contains a BIG "Documentation" link that points to
docs.rs which is broken. This commit makes that link point to our GH page.

r? @rust-embedded/cortex-m (anyone)

I have also observed that the smaller "documentation" link in the crates.io page
is ignoring the "documentation" field and pointing to docs.rs. I reported this
as a bug in rust-lang/crates.io#1485

Co-authored-by: Jorge Aparicio <jorge@japaric.io>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants