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

Make sum() and product() documentation hyperlinks refer to Iterator methods. #86389

Merged
merged 1 commit into from
Jun 17, 2021

Conversation

kpreid
Copy link
Contributor

@kpreid kpreid commented Jun 17, 2021

The previous linking seemed confusing: within "the sum() method on iterators", "sum()" was linked to Sum::sum, not Iterator::sum, even though the sentence is talking about the latter. I have rewritten the sentence to be, I believe, clearer, as well as changing the link destinations; applying the same change to the Product documentation as well as Sum.

I reviewed other traits in the same module and did not see similar issues, and previewed the results using ./x.py doc library/std.

The previous linking seemed confusing: within "the sum() method on
iterators", "sum()" was linked to `Sum::sum`, not `Iterator::sum`, even
though the sentence is talking about the latter.

I have rewritten the sentence to be, I believe, clearer, as well as
changing the link destinations; applying the same change to the
`Product` documentation as well as `Sum`.
@rust-highfive
Copy link
Collaborator

r? @scottmcm

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 17, 2021
@scottmcm
Copy link
Member

Good find; thanks!

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Jun 17, 2021

📌 Commit cb2f8d9 has been approved by scottmcm

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jun 17, 2021
bors added a commit to rust-lang-ci/rust that referenced this pull request Jun 17, 2021
Rollup of 7 pull requests

Successful merges:

 - rust-lang#85663 (Document Arc::from)
 - rust-lang#85802 (Rename IoSlice(Mut)::advance to advance_slice and add IoSlice(Mut)::advance)
 - rust-lang#85970 (Remove methods under Implementors on trait pages)
 - rust-lang#86340 (Use better error message for hard errors in CTFE)
 - rust-lang#86343 (Do not emit invalid suggestions on multiple mutable borrow errors)
 - rust-lang#86355 (Remove invalid suggestions for assoc consts on placeholder type error)
 - rust-lang#86389 (Make `sum()` and `product()` documentation hyperlinks refer to `Iterator` methods.)

Failed merges:

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 65d412b into rust-lang:master Jun 17, 2021
@rustbot rustbot added this to the 1.55.0 milestone Jun 17, 2021
@kpreid kpreid deleted the sum branch June 17, 2021 18:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants