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.

Sign up for GitHub

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

Jump to bottom

Docs pass #457

Merged
merged 1 commit into from
Sep 5, 2024
Merged

Docs pass #457

merged 1 commit into from
Sep 5, 2024

Conversation

ctz
Copy link
Member

@ctz ctz commented Sep 5, 2024

This was motivated by the new clippy::too_long_first_doc_paragraph in clippy nightly.

Aside from fixing those, this also splits other long docs into paragraphs, fixes some parameter names, and adds some extra backticks in various places.

(no code changes)

@ctz
Docs pass
bbac073 
This was motivated by the new `clippy::too_long_first_doc_paragraph`
in clippy nightly.

Aside from fixing those, this also splits other long docs into
paragraphs, fixes some parameter names, and adds some extra backticks
in various places.
cpu
cpu approved these changes Sep 5, 2024
View reviewed changes
Copy link
Member

@cpu cpu left a comment

Choose a reason for hiding this comment

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

Thanks! I took a crack at fixing this in #441 w/ b9054fe but in retrospect should have pulled it out into its own PR.

@ctz ctz merged commit d00b035 into main Sep 5, 2024
50 checks passed
@ctz ctz deleted the jbp-docs-updates branch September 5, 2024 15:45
@chenrui333 chenrui333 mentioned this pull request Sep 13, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cpu cpu cpu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ctz @cpu