From 61fe8899088fd1b0837ae083327afec5a214a84e Mon Sep 17 00:00:00 2001 From: Juliet Shackell Date: Tue, 24 Mar 2026 09:42:38 -0700 Subject: [PATCH] fix: edit messages --- messages/deploy.md | 20 ++++++++++---------- messages/init.md | 7 +++---- messages/run.md | 6 +++--- messages/scan.md | 12 ++++++------ messages/zip.md | 2 +- package.json | 16 +++++++++------- 6 files changed, 32 insertions(+), 31 deletions(-) diff --git a/messages/deploy.md b/messages/deploy.md index 8310f9a..2a10a1f 100644 --- a/messages/deploy.md +++ b/messages/deploy.md @@ -1,6 +1,6 @@ # summary -Deploy a Data Code Extension %s package to a Salesforce org +Deploy a Data Code Extension %s package to a Salesforce org. # description @@ -8,17 +8,17 @@ Deploys an initialized and packaged Data Cloud code extension to a Salesforce or # examples -- Deploy a %s package to the default org: +- Deploy a %s package to the org with alias "myorg": - <%= config.bin %> data-code-extension %s deploy --name "my-package" --version "1.0.0" --description "My package" --package-dir ./package --target-org myorg + <%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg -- Deploy with specific CPU size: +- Deploy with specific a CPU size: - <%= config.bin %> data-code-extension %s deploy --name "my-package" --version "1.0.0" --description "My package" --package-dir ./package --target-org myorg --cpu-size CPU_4XL + <%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg --cpu-size CPU_4XL - Deploy with network configuration for Jupyter notebooks: - <%= config.bin %> data-code-extension %s deploy --name "my-package" --version "1.0.0" --description "My package" --package-dir ./package --target-org myorg --network "host" + <%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg --network host # info.checkingPython @@ -86,7 +86,7 @@ Name of the package to deploy. # flags.name.description -The unique name identifier for your Data Cloud custom code package. This name will be used to identify the deployment in your Salesforce org. +The unique name identifier for your Data Cloud custom code package. This name is used to identify the deployment in your Salesforce org. # flags.version.summary @@ -94,7 +94,7 @@ Version of the package to deploy. # flags.version.description -The version string for your package deployment. Use semantic versioning (e.g., 1.0.0) to track different releases of your code. +The version string for your package deployment. Use semantic versioning (such as 1.0.0) to track different releases of your code. # flags.description.summary @@ -118,7 +118,7 @@ Directory containing the packaged code. # flags.packageDir.description -The path to the directory containing your initialized and zipped Data Cloud custom code package. This directory should contain the package files created by the 'zip' command. +The path to the directory containing your initialized and zipped Data Cloud custom code package. This directory contains the package files created by the 'zip' command. # flags.cpuSize.summary @@ -134,7 +134,7 @@ Target Salesforce org for deployment. # flags.targetOrg.description -The alias of the Salesforce org where you want to deploy the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions. +The alias or username of the Salesforce org where you want to deploy the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions. # flags.functionInvokeOpt.summary diff --git a/messages/init.md b/messages/init.md index ce8af92..6458b1a 100644 --- a/messages/init.md +++ b/messages/init.md @@ -1,6 +1,6 @@ # summary -Initialize the Data Code Extension %s package +Initialize the Data Code Extension %s package. # description @@ -46,7 +46,7 @@ Package initialized successfully at '%s' # info.fileCreated - Created: %s +Created: %s # info.initCompleted @@ -66,5 +66,4 @@ Directory path where the package will be created. # flags.packageDir.description -The directory path where the new package will be initialized. -The directory will be created if it does not exist. \ No newline at end of file +The directory path where the new package will be initialized. The directory will be created if it doesn't exist. diff --git a/messages/run.md b/messages/run.md index 43827ee..c78762f 100644 --- a/messages/run.md +++ b/messages/run.md @@ -1,6 +1,6 @@ # summary -Run a Data Code Extension %s package locally using data from your Salesforce Org +Run a Data Code Extension %s package locally using data from your Salesforce Org. # description @@ -8,7 +8,7 @@ Executes an initialized Data Cloud custom code package against a Salesforce org. # examples -- Run a %s package against the default org: +- Run a %s package against the org with alias "myorg": <%= config.bin %> data-code-extension %s run --entrypoint ./my-package --target-org myorg @@ -90,7 +90,7 @@ Target Salesforce org to run against. # flags.targetOrg.description -The alias of the Salesforce org where you want to run the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions. +The alias or username of the Salesforce org where you want to run the Data Cloud custom code package. The org must have Data Cloud enabled and appropriate permissions. # flags.configFile.summary diff --git a/messages/scan.md b/messages/scan.md index 7b5e6ca..96d7388 100644 --- a/messages/scan.md +++ b/messages/scan.md @@ -1,6 +1,6 @@ # summary -Scan the Data Code Extension %s package for permissions and dependencies +Scan the Data Code Extension %s package for permissions and dependencies. # description @@ -24,7 +24,7 @@ Scans Python files in an initialized Data Code Extension package directory to id <%= config.bin %> data-code-extension %s scan --dry-run -- Scan without updating requirements.txt: +- Scan without updating the requirements.txt file: <%= config.bin %> data-code-extension %s scan --no-requirements @@ -62,15 +62,15 @@ Package scanned successfully in '%s' # info.permissionFound - Permission required: %s +Permission required: %s # info.requirementFound - Dependency found: %s +Dependency found: %s # info.fileScanned - Scanned: %s +Scanned: %s # info.scanCompleted @@ -160,4 +160,4 @@ Skip updating the requirements.txt file. # flags.noRequirements.description -When set, only scans for permissions and updates config.json, but does not update the requirements.txt file with discovered dependencies. +When set, only scans for permissions and updates config.json, but doesn't update the requirements.txt file with discovered dependencies. diff --git a/messages/zip.md b/messages/zip.md index 541985e..4ee6595 100644 --- a/messages/zip.md +++ b/messages/zip.md @@ -1,6 +1,6 @@ # summary -Create a compressed archive of the Data Code Extension %s package +Create a compressed archive of the Data Code Extension %s package. # description diff --git a/package.json b/package.json index 4b4a181..09adca7 100644 --- a/package.json +++ b/package.json @@ -44,13 +44,15 @@ ], "topics": { "data-code-extension": { - "description": "Commands for Data Cloud Code Extension." - }, - "data-code-extension script": { - "description": "Initialize and manage script-based Data Cloud packages." - }, - "data-code-extension function": { - "description": "Initialize and manage function-based Data Cloud packages." + "description": "Commands for Data Cloud Code Extension.", + "subtopics": { + "script": { + "description": "Commands to initialize and manage script-based Data Cloud packages." + }, + "function": { + "description": "Commands to initialize and manage function-based Data Cloud packages." + } + } } }, "flexibleTaxonomy": true