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

Broken links in the documentation #935

Open
lu-zero opened this issue Aug 17, 2020 · 3 comments
Open

Broken links in the documentation #935

lu-zero opened this issue Aug 17, 2020 · 3 comments
Labels
crate/subscriber Related to the `tracing-subscriber` crate kind/bug Something isn't working kind/docs

Comments

@hawkw
Copy link
Member

hawkw commented Aug 17, 2020

Thanks for the report, I think the wrong URLs were used for those types.

We should really move over from using URL-based links to using intra-RustDoc links, since we could then get RustDoc to check for links that can't be resolved. That might deserve its own issue, though.

@hawkw hawkw added crate/subscriber Related to the `tracing-subscriber` crate kind/bug Something isn't working kind/docs labels Aug 17, 2020
@sourcefrog
Copy link
Contributor

I was looking today at https://docs.rs/tracing/latest/tracing/struct.Metadata.html#:~:text=compared%20directly%2C%20they-,provide%20a%20method%20id,-%2C%20returning%20an%20opaque which has a broken link - in fact I was going to send you a PR to fix the links, but then I saw that it was already fixed in #940, #1010, etc.

Since that was over a year ago, I wondered why the docs.rs docs are still wrong?

I can see https://docs.rs/tracing-core/latest/tracing_core/metadata/struct.Metadata.html (from tracing-core) the docs are up to date. But the version of the docs when these objects are re-exported in the tracing crate is stale...

I wondered if this was because the recently-released tracing 0.1.32 (2022-03-08) still depends on an older tracing-core 0.1.22 (2022-02-03), but that still should have had these fixes which are from significantly earlier...

@sourcefrog
Copy link
Contributor

Ah, OK: this is fixed in master, but not fixed in the v0.1.x branch that the release comes from: https://github.com/tokio-rs/tracing/blob/v0.1.x/tracing-core/src/metadata.rs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crate/subscriber Related to the `tracing-subscriber` crate kind/bug Something isn't working kind/docs
Projects
None yet
Development

No branches or pull requests

3 participants