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
Refine intra-doc links #539
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the cleanups - better docs are always nice! I skimmed through the commit and have some questions. (Not sure that I'll be able to re-visit this, though.)
Do you think you could split this up into smaller commits (e.g. one for [IntoIterator]
corrections, basically along the lines of your (possibly refinable) bullet list)? I know it puts more burden on your shoulders, but the constant context switching seems to make review quite tedious.
/// selected. This value can change between invocations of [`next`]. | ||
/// | ||
/// [`next`]: #method.next | ||
/// selected. This value can change between invocations of [`next`](Combinations::next). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Links to Combinations::next
(not Iterator::next
). Is this canonical?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure, my first thought was that it should point to the itertools
documentation instead of sending to the general trait method.
Sure, shouldn't be a problem 😄 |
7dd8d31
to
b883c2c
Compare
As requested, I split the change into smaller commits that should be more palatable 😄 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
bors r+
Build succeeded: |
A few changes to make documenting code with links simpler and more uniform.
Highlights:
IntoIterator
slice::sort*
methods in docs for sorting functions