Skip to content

IntoIterator and FromIterator say "module level documentation" but link to traits #42267

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
daboross opened this issue May 27, 2017 · 6 comments
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.

Comments

@daboross
Copy link
Contributor

At https://github.com/rust-lang/rust/blob/master/src/libcore/iter/traits.rs#L112 and https://github.com/rust-lang/rust/blob/master/src/libcore/iter/traits.rs#L220, there's text:

See the [module-level documentation] for more.

However, the links go to trait.FromIterator.html and trait.IntoIterator.html.

Would it be an alright change to have these say See the [trait-level documentation] for more information. instead?

@GuillaumeGomez
Copy link
Member

I think it's the opposite: it should really link to the iterator module level, not to the traits.

@steveklabnik
Copy link
Member

steveklabnik commented May 30, 2017

Yes, I second @GuillaumeGomez here. I'd be happy to mentor anyone who wants to make a PR for this.

@steveklabnik steveklabnik added T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion. A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools and removed T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. labels May 30, 2017
@rap2hpoutre
Copy link
Contributor

rap2hpoutre commented May 31, 2017

Ok, I could make a PR (I'm happy once again to be mentored!). Just to be sure before fixing link: does the "module-level" refers to https://doc.rust-lang.org/stable/std/iter/ (i.e replacing trait.IntoIterator.html and trait.FromIterator.html by index.html in code comment)?

EDIT: reading https://github.com/rust-lang/rust/blob/master/src/libcore/iter/iterator.rs#L26 I'm pretty sure it's OK so I sent a PR. If you think I should leave it to another person who needs mentoring, I can close.

@steveklabnik
Copy link
Member

You did it right 👍

Mark-Simulacrum added a commit to Mark-Simulacrum/rust that referenced this issue May 31, 2017
@rap2hpoutre
Copy link
Contributor

Should we close this issue?

@GuillaumeGomez
Copy link
Member

Yes!

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools E-easy Call for participation: Easy difficulty. Experience needed to fix: Not much. Good first issue. E-mentor Call for participation: This issue has a mentor. Use #t-compiler/help on Zulip for discussion.
Projects
None yet
Development

No branches or pull requests

4 participants