Correcting hyphenation in various locations in documentation #26177
Conversation
|
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 MissingOur records indicate the following people have not signed the CLA: 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 You can check yourself to see if the CLA has been received. Thanks again for the contribution, we look forward to reviewing it! |
| 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. |
There was a problem hiding this comment.
In both of these cases, I/O bound and CPU bound precede the wordtasks, so they should be hyphenated.
"Use a hyphen in a compound modifier when the modifier comes before the word it’s modifying."
| *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 |
There was a problem hiding this comment.
In this case, I/O bound precedes the word function, so it should be hyphenated.
"Use a hyphen in a compound modifier when the modifier comes before the word it’s modifying."
| rarely CPU-bound, however. | ||
| rarely CPU bound, however. |
There was a problem hiding this comment.
In this case, CPU-bound comes after the word servers, so it should not be hyphenated.
| # * 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) |
There was a problem hiding this comment.
In both of these cases, I/O bound and CPU bound precede the word task, so they should be hyphenated.
"Use a hyphen in a compound modifier when the modifier comes before the word it’s modifying."
|
Re-opened a new PR because of the errors in the branch name and commit message here: |
|
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 |
|
This PR is stale because it has been open for 30 days with no activity. |
github-actions
bot
removed
the
stale
Since these are trivial documentation changes, I did not create an issue.
There are two things this PR fixes
When two or more words form an adjective that describe some noun, and the descriptor words precede the noun, the descriptors should be hyphenated. In this case specifically, I corrected some usages of
IO boundandCPU boundto beIO-boundandCPU-bound, respectively. There are already places in Python documentation that already do this, such as "However, threading is still an appropriate model if you want to run multiple I/O-bound tasks simultaneously".It should be noted that there are places where these words shouldn't be hyphenated, such as when the descriptor words come after the noun; I've corrected a case like this as well.