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 and missing examples for TimeoutLayer #334

Closed
Nemo157 opened this issue Mar 1, 2023 · 0 comments · Fixed by #362
Closed

Broken links and missing examples for TimeoutLayer #334

Nemo157 opened this issue Mar 1, 2023 · 0 comments · Fixed by #362
Labels
E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. T-docs Topic: documentation

Comments

@Nemo157
Copy link

Nemo157 commented Mar 1, 2023

Bug Report

Version

0.4.0

Platform

https://docs.rs/tower-http/0.4.0/tower_http/

Crates

tower-http

Description

On https://docs.rs/tower-http/latest/tower_http/timeout/struct.TimeoutLayer.html and other types within this module the "See the module docs for an example." link is broken (and the module docs don't contain any example).

There are some warnings in the build logs about self being private, because this should likely be [module docs](super) as the types for this module are actually defined in sub-modules. (This is a new rustdoc warning that might make sense to add to your CI job).

@davidpdrsn davidpdrsn added E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. T-docs Topic: documentation labels Mar 1, 2023
erebe added a commit to erebe/tower-http that referenced this issue Apr 20, 2023
erebe added a commit to erebe/tower-http that referenced this issue Apr 20, 2023
erebe added a commit to erebe/tower-http that referenced this issue Apr 20, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. T-docs Topic: documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants