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

Grammatical fixes in documentation comments #1215

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

donatik27
Copy link

@donatik27 donatik27 commented Dec 5, 2024

Changes Made

File: rayon-core/src/thread_pool/mod.rs

  1. Changed compound term formatting:

    • Old: user-managed thread pools
    • New: user-managed thread-pools
      Reason: Maintaining consistent hyphenation of "thread-pool" throughout the documentation, as this compound term is used with hyphens elsewhere in the codebase.
  2. Added hyphenation for compound adjective:

    • Old: user created
    • New: user-created
      Reason: The term "user-created" should be hyphenated to correctly form a compound adjective, improving readability and grammatical accuracy.

@cuviper
Copy link
Member

cuviper commented Dec 10, 2024

Hi - the actual changes look fine, but the formatting looks mangled in your PR description, and it's excessive in the first place. Just the "Reason" statements would be sufficient.

@donatik27
Copy link
Author

Hi - the actual changes look fine, but the formatting looks mangled in your PR description, and it's excessive in the first place. Just the "Reason" statements would be sufficient.

Done

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.

2 participants