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

Use consistent wording in docs, use is 0 instead of is zero #133530

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

timvisee
Copy link
Contributor

In documentation, wording of "rhs is zero" and "rhs is 0" is intermixed. This is especially visible here.

This changes all occurrences to "rhs is 0". This variant has more occurrences in the code base. On top of that, rhs refers to a numeric value.

@rustbot
Copy link
Collaborator

rustbot commented Nov 27, 2024

r? @jhpratt

rustbot has assigned @jhpratt.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Nov 27, 2024
@timvisee timvisee changed the title Use consistent wording in comments, use is 0 instead of is zero Use consistent wording in docs, use is 0 instead of is zero Nov 27, 2024
@jhpratt
Copy link
Member

jhpratt commented Nov 27, 2024

This variant has more occurrences in the code base.

A quick rg shows that this is just barely true, 55/45 at best.

On top of that, rhs refers to a numeric value.

"zero" is still a numeric value, though?


Personally I find "zero" easier to read, so if anything I'd prefer to standardize on that. Forcing a standardization when there are two alternatives nearly evenly split, though, is almost certainly a never-ending effort.

@timvisee
Copy link
Contributor Author

I have no strong feeling about either variant, and am also happy to close this PR.

I just noticed this inconsistency while scrolling through the documentation and figured, lets suggest a simple change. I understand it'll be a never-ending effort to keep it like this and am not suggesting to enforce it.

Personally I find "zero" easier to read, so if anything I'd prefer to standardize on that.

I have to agree, "zero" is easier to read.

@jhpratt Shall I switch gears and change these to "zero", or do you prefer me to close the PR and leave it as is?

A quick rg shows that this is just barely true, 55/45 at best.

I did an exact match in which case I saw 40 matches for 0, and 14 for zero.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants