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

you we distinction #14829

Merged
merged 1 commit into from
Nov 17, 2024
Merged

you we distinction #14829

merged 1 commit into from
Nov 17, 2024

Conversation

KGrewal1
Copy link
Contributor

Cleaning up the usage of we vs you in the guide section of the book for greater consistency and clarity.

You should now refer to the reader and we to the authors of the book

@rustbot
Copy link
Collaborator

rustbot commented Nov 15, 2024

r? @weihanglo

rustbot has assigned @weihanglo.
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 A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Nov 15, 2024
@Rustin170506
Copy link
Member

I'm not sure which one is better, but using "we" is also quite common in tutorial or guide-type documents. Anyway, thanks for your contribution. Also, you need to squash your second commit. Since Cargo merges code using the merge method, it seems like the second commit could be merged into the first one!

@KGrewal1
Copy link
Contributor Author

I'm not sure which one is better, but using "we" is also quite common in tutorial or guide-type documents. Anyway, thanks for your contribution. Also, you need to squash your second commit. Since Cargo merges code using the merge method, it seems like the second commit could be merged into the first one!

Squashed into one commit now - aim was to make this more consistent between pages / paragraphs - advantage of 'you / we' is greater clarity in who is being referred to, but agree that we for everything is also common - just ideally whichever choice should be consistent

@ehuss
Copy link
Contributor

ehuss commented Nov 16, 2024

Microsoft's style guide suggests Avoid plural first person, which I agree with.

Copy link
Member

@weihanglo weihanglo left a comment

Choose a reason for hiding this comment

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

First, get the package from somewhere. In this example, we’ll use `regex`

This also need a tweak?

@KGrewal1
Copy link
Contributor Author

KGrewal1 commented Nov 17, 2024

Couldn't think of a non clunky way to remove the pronoun here, "you'll use" sounds imperative and worse, "let's use" is still 1st person plural, and removing the pronoun ("In this example, using regex") I thought was subjectively worse

@weihanglo
Copy link
Member

That's true. Let's merge this now, as people seem to like this :)

@weihanglo weihanglo added this pull request to the merge queue Nov 17, 2024
Merged via the queue into rust-lang:master with commit 8862183 Nov 17, 2024
20 checks passed
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 20, 2024
Update cargo

5 commits in 69e595908e2c420e7f0d1be34e6c5b984c8cfb84..66221abdeca2002d318fde6efff516aab091df0e
2024-11-16 01:26:11 +0000 to 2024-11-19 21:30:02 +0000
- Docs for optional registry JSON fields (rust-lang/cargo#14839)
- Allow registries to omit empty/default fields in JSON (rust-lang/cargo#14838)
- docs(unstable): Link to -Zwarnings issue, tracking issue (rust-lang/cargo#14836)
- fix(): error context for git_fetch refspec not found (rust-lang/cargo#14806)
- you we distinction (rust-lang/cargo#14829)
bors added a commit to rust-lang-ci/rust that referenced this pull request Nov 20, 2024
Update cargo

5 commits in 69e595908e2c420e7f0d1be34e6c5b984c8cfb84..66221abdeca2002d318fde6efff516aab091df0e
2024-11-16 01:26:11 +0000 to 2024-11-19 21:30:02 +0000
- Docs for optional registry JSON fields (rust-lang/cargo#14839)
- Allow registries to omit empty/default fields in JSON (rust-lang/cargo#14838)
- docs(unstable): Link to -Zwarnings issue, tracking issue (rust-lang/cargo#14836)
- fix(): error context for git_fetch refspec not found (rust-lang/cargo#14806)
- you we distinction (rust-lang/cargo#14829)
RalfJung pushed a commit to RalfJung/miri that referenced this pull request Nov 21, 2024
Update cargo

5 commits in 69e595908e2c420e7f0d1be34e6c5b984c8cfb84..66221abdeca2002d318fde6efff516aab091df0e
2024-11-16 01:26:11 +0000 to 2024-11-19 21:30:02 +0000
- Docs for optional registry JSON fields (rust-lang/cargo#14839)
- Allow registries to omit empty/default fields in JSON (rust-lang/cargo#14838)
- docs(unstable): Link to -Zwarnings issue, tracking issue (rust-lang/cargo#14836)
- fix(): error context for git_fetch refspec not found (rust-lang/cargo#14806)
- you we distinction (rust-lang/cargo#14829)
@weihanglo weihanglo added this to the 1.84.0 milestone Nov 28, 2024
lnicola pushed a commit to lnicola/rust-analyzer that referenced this pull request Nov 28, 2024
Update cargo

5 commits in 69e595908e2c420e7f0d1be34e6c5b984c8cfb84..66221abdeca2002d318fde6efff516aab091df0e
2024-11-16 01:26:11 +0000 to 2024-11-19 21:30:02 +0000
- Docs for optional registry JSON fields (rust-lang/cargo#14839)
- Allow registries to omit empty/default fields in JSON (rust-lang/cargo#14838)
- docs(unstable): Link to -Zwarnings issue, tracking issue (rust-lang/cargo#14836)
- fix(): error context for git_fetch refspec not found (rust-lang/cargo#14806)
- you we distinction (rust-lang/cargo#14829)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documenting-cargo-itself Area: Cargo's documentation S-waiting-on-review Status: Awaiting review from the assignee but also interested parties.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants