Correcting hyphenation in various locations in documentation by JosephTLyons · Pull Request #26177 · python/cpython

JosephTLyons

@JosephTLyons

@the-knights-who-say-ni

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

CLA Missing

Our records indicate the following people have not signed the CLA:

@JosephTLyons

For legal reasons we need all the people listed to sign the CLA before we can look at your contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

If you have recently signed the CLA, please wait at least one business day
before our records are updated.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

JosephTLyons

Comment on lines -176 to +177

This default value preserves at least 5 workers for I/O bound tasks.
It utilizes at most 32 CPU cores for CPU bound tasks which release the GIL.
This default value preserves at least 5 workers for I/O-bound tasks.
It utilizes at most 32 CPU cores for CPU-bound tasks which release the GIL.

Choose a reason for hiding this comment

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

JosephTLyons

*maxsize* most recent calls. It can save time when an expensive or I/O bound
*maxsize* most recent calls. It can save time when an expensive or I/O-bound

Choose a reason for hiding this comment

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

JosephTLyons

rarely CPU-bound, however.
rarely CPU bound, however.

Choose a reason for hiding this comment

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

JosephTLyons

Comment on lines -130 to +131

# * CPU bound task which releases GIL
# * I/O bound task (which releases GIL, of course)
# * CPU-bound task which releases GIL
# * I/O-bound task (which releases GIL, of course)

Choose a reason for hiding this comment

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

@JosephTLyons

Re-opened a new PR because of the errors in the branch name and commit message here:

#26173

@rhettinger

I did a quick scan of articles mentioning the term. It appears that than non-hypenated form is more common. I say we leave it as-is.

@JosephTLyons

I did a quick scan of articles mentioning the term. It appears that than non-hypenated form is more common. I say we leave it as-is.

There are places in the documentation right now that follow these hyphenation rules, so as is, there are discrepancies. I believe that if the overall opinion is to not hyphenate, then the other instances that already exist should be adjusted, for consistency.

It should probably also be noted that some places in the documentation use IO and other places use I/O.

@github-actions

This PR is stale because it has been open for 30 days with no activity.