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

Fix user's pronoun in mvnd.properties comment #585

Merged
merged 1 commit into from
Jan 19, 2022
Merged

Conversation

findepi
Copy link
Member

@findepi findepi commented Jan 18, 2022

No description provided.

@@ -86,7 +86,7 @@
# MVND_MIN_THREADS
# The minimum number of threads to use when constructing the default {@code -T} parameter for the daemon.
# This value is ignored if the user passes @{@code -T}, @{@code --threads} or {@code -Dmvnd.threads} on the command
# line or if he sets {@code mvnd.threads} in {@code ~/.m2/mvnd.properties}.
# line or if they set {@code mvnd.threads} in {@code ~/.m2/mvnd.properties}.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we can use they and user which is singular. We could use a passive sentence though: or if {@code mvnd.threads} is set in ... which would be better because the value could have been set in the git repo and not directly by the user.

Copy link
Contributor

Choose a reason for hiding this comment

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

The use of they in this context is valid; it's called the singular they. (But the passive alternative works too 👍.)

Copy link
Contributor

Choose a reason for hiding this comment

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

I'd rather use the passive one.

Copy link
Member Author

@findepi findepi Jan 18, 2022

Choose a reason for hiding this comment

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

they is correct in English
i wouldn't use one myself ("or if one sets"), but that's not a reflection on correctness.
i find passive version a slightly harder to follow, so would prefer they, but can change anyway

Copy link
Member Author

Choose a reason for hiding this comment

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

@gnodet @Stephan202 which you prefer?

Copy link
Contributor

Choose a reason for hiding this comment

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

Right now the text mixes several grammatical forms. How about:

# The minimum number of threads to use when constructing the default {@code -T} 
# parameter for the daemon. This value is ignored if @{@code -T}, @{@code
# --threads} or {@code -Dmvnd.threads} is explicitly specified on the command
# line, or if {@code mvnd.threads} is specified in {@code ~/.m2/mvnd.properties}.

This avoids any explicit mention of the user.

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks @Stephan202 changed to your suggestion. I omitted, "explicitly" (in "explicitly specified"), as it sounded unnecessary.

Copy link
Contributor

Choose a reason for hiding this comment

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

@Stephan202 can you change the PR with your last proposal please ?

Copy link
Contributor

Choose a reason for hiding this comment

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

@gnodet I don't have access to this branch; @findepi did apply the change (modulo the word "explicitly", which LGTM).

Copy link
Member Author

Choose a reason for hiding this comment

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

I enabled Allow edits by maintainers if this is needed.

@@ -86,7 +86,7 @@
# MVND_MIN_THREADS
# The minimum number of threads to use when constructing the default {@code -T} parameter for the daemon.
# This value is ignored if the user passes @{@code -T}, @{@code --threads} or {@code -Dmvnd.threads} on the command
# line or if he sets {@code mvnd.threads} in {@code ~/.m2/mvnd.properties}.
# line or if they set {@code mvnd.threads} in {@code ~/.m2/mvnd.properties}.
Copy link
Contributor

Choose a reason for hiding this comment

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

The use of they in this context is valid; it's called the singular they. (But the passive alternative works too 👍.)

@findepi findepi force-pushed the patch-1 branch 2 times, most recently from 8413ec2 to c416d80 Compare January 19, 2022 08:25
@gnodet gnodet merged commit 4b4288b into apache:master Jan 19, 2022
@gnodet gnodet added this to the 0.7.2 milestone Jan 19, 2022
@findepi findepi deleted the patch-1 branch January 19, 2022 15:35
@findepi
Copy link
Member Author

findepi commented Jan 19, 2022

thanks @gnodet for the merge.

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.

None yet

3 participants