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

Refine intra-doc links #539

Merged
merged 6 commits into from Jun 9, 2021
Merged

Conversation

tranzystorekk
Copy link
Contributor

A few changes to make documenting code with links simpler and more uniform.

Highlights:

  • Make some common stdlib traits into links, e.g. IntoIterator
  • Add links to docs for free functions
  • Use module paths uniformly in links (instead of html paths)
  • Link to slice::sort* methods in docs for sorting functions

Copy link
Member

@phimuemue phimuemue left a 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).
Copy link
Member

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?

Copy link
Contributor Author

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.

src/free.rs Outdated Show resolved Hide resolved
@tranzystorekk
Copy link
Contributor Author

Do you think you could split this up into smaller commits

Sure, shouldn't be a problem 😄

@tranzystorekk
Copy link
Contributor Author

As requested, I split the change into smaller commits that should be more palatable 😄

Copy link
Member

@jswrenn jswrenn left a comment

Choose a reason for hiding this comment

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

bors r+

@jswrenn jswrenn added this to the next milestone Jun 9, 2021
@bors
Copy link
Contributor

bors bot commented Jun 9, 2021

Build succeeded:

@bors bors bot merged commit e1f24ba into rust-itertools:master Jun 9, 2021
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.

None yet

3 participants