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: convert to intra-doc links #466

Merged
merged 1 commit into from
Mar 3, 2021
Merged

Conversation

Folyd
Copy link
Contributor

@Folyd Folyd commented Mar 3, 2021

This PR converts all legacy-style doc links to intra-doc links.

@Folyd Folyd requested a review from a team March 3, 2021 08:20
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Mar 3, 2021

CLA Signed

The committers are authorized under a signed CLA.

Copy link
Contributor

@djc djc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks!

The only thing I was thinking about is that I don't love the super::super (although clearly that's kind of how it was before). How do you feel about replacing those with crate::-rooted paths?

@Folyd
Copy link
Contributor Author

Folyd commented Mar 3, 2021

This looks great, thanks!

The only thing I was thinking about is that I don't love the super::super (although clearly that's kind of how it was before). How do you feel about replacing those with crate::-rooted paths?

Thanks for reviewing. This has been fixed with the new patch. 🍺

@djc
Copy link
Contributor

djc commented Mar 3, 2021

Nice, thanks!

Copy link
Contributor

@TommyCpp TommyCpp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

$ cargo doc --no-deps     
warning: unresolved link to `GlobalProvider`
  --> opentelemetry/src/global/trace.rs:68:16
   |
68 | /// Wraps the [`GlobalProvider`]'s [`Tracer`] so it can be used generically by
   |                ^^^^^^^^^^^^^^^^ no item named `GlobalProvider` in scope
   |
   = note: `#[warn(broken_intra_doc_links)]` on by default
   = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`

Thanks for the great work! I think this should be crate::global::GlobalTracerProvider. We rename it from GlobalProvider a while ago but didn't seem to update the doc.

@Folyd
Copy link
Contributor Author

Folyd commented Mar 3, 2021

I think this should be crate::global::GlobalTracerProvider. We rename it from GlobalProvider a while ago but didn't seem to update the doc.

@TommyCpp This has been resolved. Thanks a lot.

@jtescher jtescher merged commit dd9c8e9 into open-telemetry:main Mar 3, 2021
@Folyd Folyd deleted the intradoc branch March 19, 2021 08:42
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.

4 participants