fix: remove longDescription and help for description

salesforcecli · Aug 23, 2022 · 8ea4663 · 8ea4663
1 parent 4680be9
commit 8ea4663
Show file tree

Hide file tree

Showing 45 changed files with 17 additions and 159 deletions.
diff --git a/messages/package1_version_create.md b/messages/package1_version_create.md
@@ -9,13 +9,6 @@ Use the package1 commands to create and view first-generation package versions i
 # cliDescription
 
 create a first-generation package version in the release org
-
-# cliDescriptionLong
-
-Creates a first-generation package version in the release org.
-
-# cliHelp
-
 The package version is based on the contents of the specified metadata package. Omit -m if you want to create an unmanaged package version.
 
 # id

diff --git a/messages/package2_version_get.md b/messages/package2_version_get.md
@@ -6,7 +6,7 @@ retrieve a package version in the Dev Hub org
 
 Retrieves a package version in the Dev Hub org.
 
-#examples
+# examples
 
 $ sfdx force:package2:version:get --package2versionid 05i...
 

diff --git a/messages/package_convert.md b/messages/package_convert.md
@@ -2,12 +2,6 @@
 
 creates a second-generation package version from a first-generation package
 
-# cliLongDescription
-
-Creates a second-generation package in the Dev Hub from a first-generation package in the Dev Hub org.
-
-# help
-
 The package convert creates a new package in the Dev Hub if one does not already exist for the specified first-generation package.
 
 It then creates a new package version in the Dev Hub with contents based on the specified first-generation package.

diff --git a/messages/package_create.md b/messages/package_create.md
@@ -2,12 +2,6 @@
 
 create a package
 
-# cliLongDescription
-
-Creates a package.
-
-# help
-
 First, use this command to create a package. Then create a package version.
 
 If you don’t have a namespace defined in your sfdx-project.json file, use --nonamespace.

diff --git a/messages/package_delete.md b/messages/package_delete.md
@@ -2,14 +2,10 @@
 
 delete a package
 
-# cliLongDescription
+Specify the ID or alias of the package you want to delete.
 
 Delete unlocked and second-generation managed packages. Before you delete a package, first delete all associated package versions.
 
-# help
-
-Specify the ID or alias of the package you want to delete.
-
 # examples
 
 $ sfdx force:package:delete -p "Your Package Alias"

diff --git a/messages/package_displayancestry.md b/messages/package_displayancestry.md
@@ -2,11 +2,7 @@
 
 display the ancestry tree for a 2GP managed package version
 
-# cliDescriptionLong
-
-Displays the ancestry tree for a 2GP managed package version.
-
-#examples
+# examples
 
 $ sfdx force:package:version:displayancestry -p package_version_alias
 $ sfdx force:package:version:displayancestry -p package_version_alias --dotcode

diff --git a/messages/package_install.md b/messages/package_install.md
@@ -2,12 +2,6 @@
 
 install a package in the target org
 
-# cliDescriptionLong
-
-Installs a package in the target org.
-
-# help
-
 Supply the ID of the package version to install. The package installs in your default target org unless you supply the username for a different target org.
 
 For package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgradetype value. To delete components that can be safely deleted and deprecate the others, specify --upgradetype Mixed (the default). To deprecate all removed components, specify --upgradetype DeprecateOnly. To delete all removed components, except for custom objects and custom fields, that don't have dependencies, specify --upgradetype Delete. (Note: This option can result in the loss of data that is associated with the deleted components.) The default is Mixed.

diff --git a/messages/package_install_get.md b/messages/package_install_get.md
@@ -6,7 +6,7 @@ retrieve the status of a package installation request
 
 Retrieves the status of a package installation request.
 
-#examples
+# examples
 
 $ sfdx force:package:install:get -i 0Hf...
 $ sfdx force:package:install:get -i 0Hf... -u me@example.com

diff --git a/messages/package_install_report.md b/messages/package_install_report.md
@@ -2,10 +2,6 @@
 
 retrieve the status of a package installation request
 
-# cliDescriptionLong
-
-Retrieves the status of a package installation request.
-
 # examples
 
 $ sfdx force:package:install:report -i 0Hf...

diff --git a/messages/package_install_request.md b/messages/package_install_request.md
@@ -6,7 +6,7 @@
 
 Retrieves the status of a package installion request.
 
-#examples
+# examples
 
 $ sfdx force:package:install:get -i 0Hf...
 $ sfdx force:package:install:get -i 0Hf... -u me@example.com

diff --git a/messages/package_installed_list.md b/messages/package_installed_list.md
@@ -2,10 +2,6 @@
 
 list the org’s installed packages
 
-# cliLongDescription
-
-Lists all packages installed in the target org.
-
 # examples
 
 $ sfdx force:package:installed:list

diff --git a/messages/package_list.md b/messages/package_list.md
@@ -2,12 +2,6 @@
 
 list all packages in the Dev Hub org
 
-# cliLongDescription
-
-Lists all packages in the Dev Hub org.
-
-# help
-
 You can view the namespace, IDs, and other details for each package.
 
 # examples

diff --git a/messages/package_uninstall.md b/messages/package_uninstall.md
@@ -2,12 +2,6 @@
 
 uninstall a second-generation package from the target org
 
-# cliDescriptionLong
-
-Uninstalls a second-generation package from the target org. To uninstall a first-generation package, use the Salesforce user interface.
-
-# help
-
 Specify the package ID for a second-generation package.
 
 # examples

diff --git a/messages/package_uninstall_get.md b/messages/package_uninstall_get.md
@@ -6,7 +6,7 @@ retrieve the status of a package uninstall request
 
 Retrieves the status of a package uninstall request.
 
-#examples
+# examples
 
 $ sfdx force:package:uninstall:get -i 06y...
 $ sfdx force:package:uninstall:get -i 06y... -u me@example.com

diff --git a/messages/package_uninstall_report.md b/messages/package_uninstall_report.md
@@ -2,11 +2,7 @@
 
 retrieve status of package uninstall request
 
-# cliDescriptionLong
-
-Retrieves the status of a package uninstall request.
-
-#examples
+# examples
 
 $ sfdx force:package:uninstall:report -i 06y...
 $ sfdx force:package:uninstall:report -i 06y... -u me@example.com

diff --git a/messages/package_update.md b/messages/package_update.md
@@ -2,12 +2,6 @@
 
 update package details
 
-# cliLongDescription
-
-Updates details about a package. Does not create a package version.
-
-# help
-
 Specify a new value for each option you want to update.
 
 # examples

diff --git a/messages/package_version_create_list.md b/messages/package_version_create_list.md
@@ -2,9 +2,11 @@
 
 list package version creation requests
 
-# cliLongDescription
+Shows the details of each request to create a package version in the Dev Hub org.
+
+All filter parameters are applied using the AND logical operator (not OR).
 
-Lists all requests to create second-generation package versions in the Dev Hub org.
+To get information about a specific request, run "sfdx force:package:version:create:report" and supply the request ID.
 
 # statusDescription
 
@@ -14,14 +16,6 @@ filter the list by version creation request status
 
 Filters the list based on the status of version creation requests.
 
-# help
-
-Shows the details of each request to create a package version in the Dev Hub org.
-
-All filter parameters are applied using the AND logical operator (not OR).
-
-To get information about a specific request, run "sfdx force:package:version:create:report" and supply the request ID.
-
 # examples
 
 $ sfdx force:package:version:create:list

diff --git a/messages/package_version_create_report.md b/messages/package_version_create_report.md
@@ -2,12 +2,6 @@
 
 retrieve details about a package version creation request
 
-# cliLongDescription
-
-Retrieves details about a package version creation request in the Dev Hub org.
-
-# help
-
 Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.
 
 # examples

diff --git a/messages/package_version_delete.md b/messages/package_version_delete.md
@@ -1,13 +1,6 @@
 # cliDescription
 
 delete a package version
-
-# cliLongDescription
-
-Delete unlocked and second-generation managed package versions.
-
-# help
-
 Specify the ID or alias of the package version you want to delete.
 
 # examples

diff --git a/messages/package_version_list.md b/messages/package_version_list.md
@@ -1,10 +1,12 @@
 # cliDescription
 
-list all package versions in the Dev Hub org
+list all package versions in the Dev Hub org.
 
-# cliLongDescription
+Displays details of each package version in the org.
+
+Use --concise or --verbose to display limited or additional details, respectively.
 
-Lists all package versions in the Dev Hub org.
+All filter parameters are applied using the AND logical operator (not OR).
 
 # conciseDescription
 
@@ -46,14 +48,6 @@ display extended package version details
 
 Displays extended package version details.
 
-# help
-
-Displays details of each package version in the org.
-
-Use --concise or --verbose to display limited or additional details, respectively.
-
-All filter parameters are applied using the AND logical operator (not OR).
-
 # examples
 
 $ sfdx force:package:version:list --verbose --createdlastdays 3 --released --orderby PatchVersion

diff --git a/messages/package_version_promote.md b/messages/package_version_promote.md
@@ -2,12 +2,6 @@
 
 promote a package version to released
 
-# cliDescriptionLong
-
-Promotes a package version to released status.
-
-# help
-
 Supply the ID or alias of the package version you want to promote. Promotes the package version to released status.
 
 # examples

diff --git a/messages/package_version_report.md b/messages/package_version_report.md
@@ -2,10 +2,6 @@
 
 retrieve details about a package version in the Dev Hub org
 
-# cliLongDescription
-
-Retrieves details about a package version in the Dev Hub org.
-
 # examples
 
 $ sfdx force:package:version:report -p 04t...

diff --git a/messages/package_version_update.md b/messages/package_version_update.md
@@ -2,12 +2,6 @@
 
 update a package version
 
-# cliLongDescription
-
-Updates a second-generation package version in the Dev Hub org.
-
-# help
-
 Specify a new value for each option you want to update.
 
 # examples

diff --git a/src/commands/force/package/beta/convert.ts b/src/commands/force/package/beta/convert.ts
@@ -15,8 +15,6 @@ const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_
 
 export class PackageConvert extends SfdxCommand {
   public static readonly description = messages.getMessage('cliDescription');
-  public static readonly longDescription = messages.getMessage('cliLongDescription');
-  public static readonly help = messages.getMessage('help');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
   public static readonly requiresDevhubUsername = true;
   public static readonly hidden = true;

diff --git a/src/commands/force/package/beta/create.ts b/src/commands/force/package/beta/create.ts
@@ -22,8 +22,6 @@ const packageVersionCreate = Messages.loadMessages('@salesforce/plugin-packaging
 
 export class PackageCreateCommand extends SfdxCommand {
   public static readonly description = messages.getMessage('cliDescription');
-  public static readonly longDescription = messages.getMessage('cliLongDescription');
-  public static readonly help = messages.getMessage('help');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
   public static readonly requiresDevhubUsername = true;
   public static readonly requiresProject = true;

diff --git a/src/commands/force/package/beta/delete.ts b/src/commands/force/package/beta/delete.ts
@@ -15,8 +15,6 @@ const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_
 
 export class PackageDeleteCommand extends SfdxCommand {
   public static readonly description = messages.getMessage('cliDescription');
-  public static readonly longDescription = messages.getMessage('cliLongDescription');
-  public static readonly help = messages.getMessage('help');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
   public static readonly requiresDevhubUsername = true;
   public static readonly requiresProject = true;

diff --git a/src/commands/force/package/beta/install.ts b/src/commands/force/package/beta/install.ts
@@ -31,8 +31,6 @@ const upgradeType = { Delete: 'delete-only', DeprecateOnly: 'deprecate-only', Mi
 
 export class Install extends SfdxCommand {
   public static readonly description = messages.getMessage('cliDescription');
-  public static readonly longDescription = messages.getMessage('cliDescriptionLong');
-  public static readonly help = messages.getMessage('help');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
   public static readonly requiresUsername = true;
   public static readonly flagsConfig: FlagsConfig = {

diff --git a/src/commands/force/package/beta/install/report.ts b/src/commands/force/package/beta/install/report.ts
@@ -18,7 +18,6 @@ const installMsgs = Messages.loadMessages('@salesforce/plugin-packaging', 'packa
 
 export class Report extends SfdxCommand {
   public static readonly description = messages.getMessage('cliDescription');
-  public static readonly longDescription = messages.getMessage('cliDescriptionLong');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
   public static readonly requiresUsername = true;
   public static readonly flagsConfig: FlagsConfig = {

diff --git a/src/commands/force/package/beta/installed/list.ts b/src/commands/force/package/beta/installed/list.ts
@@ -26,7 +26,6 @@ export type PackageInstalledListResult = {
 
 export class PackageInstalledListCommand extends SfdxCommand {
   public static readonly description = messages.getMessage('cliDescription');
-  public static readonly longDescription = messages.getMessage('cliLongDescription');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
   public static readonly requiresUsername = true;
   public static readonly requiresProject = true;

diff --git a/src/commands/force/package/beta/list.ts b/src/commands/force/package/beta/list.ts
@@ -35,8 +35,6 @@ export type Package2Result = Partial<
 
 export class PackageListCommand extends SfdxCommand {
   public static readonly description = messages.getMessage('cliDescription');
-  public static readonly longDescription = messages.getMessage('cliLongDescription');
-  public static readonly help = messages.getMessage('help');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
   public static readonly requiresProject = true;
   public static readonly requiresDevhubUsername = true;

diff --git a/src/commands/force/package/beta/uninstall.ts b/src/commands/force/package/beta/uninstall.ts
@@ -19,8 +19,6 @@ const installMsgs = Messages.loadMessages('@salesforce/plugin-packaging', 'packa
 
 export class PackageUninstallCommand extends SfdxCommand {
   public static readonly description = messages.getMessage('cliDescription');
-  public static readonly longDescription = messages.getMessage('cliDescriptionLong');
-  public static readonly help = messages.getMessage('help');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
   public static readonly requiresUsername = true;
   public static readonly flagsConfig: FlagsConfig = {

diff --git a/src/commands/force/package/beta/uninstall/report.ts b/src/commands/force/package/beta/uninstall/report.ts
@@ -14,7 +14,6 @@ const messages = Messages.loadMessages('@salesforce/plugin-packaging', 'package_
 
 export class PackageUninstallReportCommand extends SfdxCommand {
   public static readonly description = messages.getMessage('cliDescription');
-  public static readonly longDescription = messages.getMessage('cliDescriptionLong');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
   public static readonly requiresUsername = true;
   public static readonly flagsConfig: FlagsConfig = {