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

chore: fix doc url #280

Merged
merged 1 commit into from
Apr 16, 2024
Merged

chore: fix doc url #280

merged 1 commit into from
Apr 16, 2024

Conversation

stoeckmann
Copy link
Contributor

It has to end with version (or latest).
Fixes ecb7374.

Just checked. Otherwise the links are broken. Sorry for the second push into the previous branch.

It has to end with version (or latest).
Fixes ecb7374.
@Stebalien
Copy link
Owner

Where is this broken? https://docs.rs/tempfile/latest/tempfile works just fine for me.

@stoeckmann
Copy link
Contributor Author

The automatically generated URLs would point to the wrong locations though, since they append tempfile to the given URL on their own. So it would be https://docs.rs/tempfile/latest/tempfile/tempfile/...

@Stebalien
Copy link
Owner

Ah, got it.

@Stebalien
Copy link
Owner

Hm. Actually, do we even need this attribute? I think we can just get rid of the entire doc attribute.

@stoeckmann
Copy link
Contributor Author

It's not a requirement for tempfile itself, see https://doc.rust-lang.org/rustdoc/write-documentation/the-doc-attribute.html#html_root_url

It helps if someone has tempfile as a dependency and runs cargo doc --no-deps. The generated HTML files link to the tempfile documents at the given root. If no such root is given, no links are created.

So, nothing really bad happens if it's gone.

@Stebalien Stebalien merged commit 73e92b3 into Stebalien:master Apr 16, 2024
13 checks passed
@Stebalien
Copy link
Owner

Ok, might as well fix it. Thanks!

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

Successfully merging this pull request may close these issues.

2 participants