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

Minor edits to descriptions. #7

Merged
merged 2 commits into from
Mar 2, 2020

Conversation

davejaco
Copy link
Contributor

No description provided.

"commandDescription": "create a Lightning web component test with boilerplate code inside a __tests__ directory",
"longDescription": "Creates a __tests__ directory in the specified directory. Creates a boilerplate yourComponentName.test.js file in the __tests__ directory.",
"commandDescription": "creates a Lightning web component test file with boilerplate code inside a __tests__ directory.",
"commandLongDescription": "Creates a __tests__ directory in the specified directory. Creates a yourComponentName.test.js file with boilerplate code in the __tests__ directory.",

Choose a reason for hiding this comment

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

Do you know if this is automatically consumed somewhere by SFDX? Some of the messages are directly imported by the plugin, but I didn't see anything directly importing longDescription.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I get the impression from this doc
https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_style_help.htm
that commandLongDescription is automatically consumed and ends up in the output here https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_lightning.htm#cli_reference_force_lightning
and it seems (again, hard to tell for sure) like if you don't have a commandLongDescription it uses the commandDescription (short one). I don't see longDescription showing up anywhere.

@trevor-bliss trevor-bliss merged commit 1621ba1 into salesforcecli:master Mar 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants