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

Change the label for "Implications failed:" in English #1317

Merged
merged 6 commits into from May 8, 2019

Conversation

jandockx
Copy link
Contributor

The word "implications" is extremely confusing here. It is only people who know the Yargs API that understand that these are the dependencies created by the implies() method.
Users of the CLI have no idea what we are talking about.

This changes the label of the concept to "required argument dependencies".

This string is used in the code as the prelude to a list of "implications" that have failed, not a warning. The earlier form was more an expression of a warning. The new form is more an expression of a title of a list.

locales/en.json Outdated
@@ -29,7 +29,7 @@
"Invalid values:": "Invalid values:",
"Argument: %s, Given: %s, Choices: %s": "Argument: %s, Given: %s, Choices: %s",
"Argument check failed: %s": "Argument check failed: %s",
"Implications failed:": "Implications failed:",
"Implications failed:": "Missing required argument dependencies:",
Copy link
Member

Choose a reason for hiding this comment

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

perhaps "missing implied arguments", or "missing dependent arguments"?

Copy link
Member

@bcoe bcoe left a comment

Choose a reason for hiding this comment

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

how do you feel about missing dependent arguments, I think that might be more clear.

@bcoe
Copy link
Member

bcoe commented May 5, 2019

@jandockx 👋 just putting this back on your radar; still an edit you'd like to make?

@jandockx
Copy link
Contributor Author

jandockx commented May 6, 2019

Hello, @bcoe.

I still think the current English message is confusing.

'Missing dependent arguments' sounds fine to me, but the point is I am not a native English speaker. Advise on this topic from native English speakers (like you, I presume) might be more relevant, wouldn't it?

If your intention is for me to change the PR to 'Missing dependent arguments', pls confirm, and I'll do so.

@bcoe
Copy link
Member

bcoe commented May 6, 2019

@jandockx 👍 yes, please change the language to Missing dependent arguments.

I appreciate your help reviewing the language.

The word "implications" is extremely confusing here. It is only people who know the Yargs API that understand that these are the dependencies created by the `implies()` method.
Users of the CLI have no idea what we are talking about.

This changes the label of the concept to "required argument dependencies".

This string is used in the code as the prelude to a list of "implications" that have failed, not a warning. The earlier form was more an expression of a warning. The new form is more an expression of a title of a list.
…" to a phrase like "Missing dependent arguments:" in English
automatically use the expected English validation message
@jandockx jandockx force-pushed the feature/implications_failed branch from 0b694dc to ad22e4d Compare May 7, 2019 07:34
automatically use the expected English validation message
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

2 participants