Skip to content

Commit 61fe889

Browse files
fix: edit messages
1 parent c006274 commit 61fe889

6 files changed

Lines changed: 32 additions & 31 deletions

File tree

messages/deploy.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# summary
22

3-
Deploy a Data Code Extension %s package to a Salesforce org
3+
Deploy a Data Code Extension %s package to a Salesforce org.
44

55
# description
66

77
Deploys an initialized and packaged Data Cloud code extension to a Salesforce org. The package must be initialized and zipped before deployment. Supports both script and function packages with configurable CPU resources and network settings.
88

99
# examples
1010

11-
- Deploy a %s package to the default org:
11+
- Deploy a %s package to the org with alias "myorg":
1212

13-
<%= config.bin %> data-code-extension %s deploy --name "my-package" --version "1.0.0" --description "My package" --package-dir ./package --target-org myorg
13+
<%= config.bin %> data-code-extension %s deploy --name my-package --package-version 1.0.0 --description "My package" --package-dir ./package --target-org myorg
1414

15-
- Deploy with specific CPU size:
15+
- Deploy with specific a CPU size:
1616

17-
<%= 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
17+
<%= 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
1818

1919
- Deploy with network configuration for Jupyter notebooks:
2020

21-
<%= 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"
21+
<%= 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
2222

2323
# info.checkingPython
2424

@@ -86,15 +86,15 @@ Name of the package to deploy.
8686

8787
# flags.name.description
8888

89-
The unique name identifier for your Data Cloud custom code package. This name will be used to identify the deployment in your Salesforce org.
89+
The unique name identifier for your Data Cloud custom code package. This name is used to identify the deployment in your Salesforce org.
9090

9191
# flags.version.summary
9292

9393
Version of the package to deploy.
9494

9595
# flags.version.description
9696

97-
The version string for your package deployment. Use semantic versioning (e.g., 1.0.0) to track different releases of your code.
97+
The version string for your package deployment. Use semantic versioning (such as 1.0.0) to track different releases of your code.
9898

9999
# flags.description.summary
100100

@@ -118,7 +118,7 @@ Directory containing the packaged code.
118118

119119
# flags.packageDir.description
120120

121-
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.
121+
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.
122122

123123
# flags.cpuSize.summary
124124

@@ -134,7 +134,7 @@ Target Salesforce org for deployment.
134134

135135
# flags.targetOrg.description
136136

137-
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.
137+
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.
138138

139139
# flags.functionInvokeOpt.summary
140140

messages/init.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# summary
22

3-
Initialize the Data Code Extension %s package
3+
Initialize the Data Code Extension %s package.
44

55
# description
66

@@ -46,7 +46,7 @@ Package initialized successfully at '%s'
4646

4747
# info.fileCreated
4848

49-
Created: %s
49+
Created: %s
5050

5151
# info.initCompleted
5252

@@ -66,5 +66,4 @@ Directory path where the package will be created.
6666

6767
# flags.packageDir.description
6868

69-
The directory path where the new package will be initialized.
70-
The directory will be created if it does not exist.
69+
The directory path where the new package will be initialized. The directory will be created if it doesn't exist.

messages/run.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# summary
22

3-
Run a Data Code Extension %s package locally using data from your Salesforce Org
3+
Run a Data Code Extension %s package locally using data from your Salesforce Org.
44

55
# description
66

77
Executes an initialized Data Cloud custom code package against a Salesforce org. The package must be initialized before running. Supports both script and function packages with optional config file and dependencies overrides.
88

99
# examples
1010

11-
- Run a %s package against the default org:
11+
- Run a %s package against the org with alias "myorg":
1212

1313
<%= config.bin %> data-code-extension %s run --entrypoint ./my-package --target-org myorg
1414

@@ -90,7 +90,7 @@ Target Salesforce org to run against.
9090

9191
# flags.targetOrg.description
9292

93-
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.
93+
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.
9494

9595
# flags.configFile.summary
9696

messages/scan.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# summary
22

3-
Scan the Data Code Extension %s package for permissions and dependencies
3+
Scan the Data Code Extension %s package for permissions and dependencies.
44

55
# description
66

@@ -24,7 +24,7 @@ Scans Python files in an initialized Data Code Extension package directory to id
2424

2525
<%= config.bin %> data-code-extension %s scan --dry-run
2626

27-
- Scan without updating requirements.txt:
27+
- Scan without updating the requirements.txt file:
2828

2929
<%= config.bin %> data-code-extension %s scan --no-requirements
3030

@@ -62,15 +62,15 @@ Package scanned successfully in '%s'
6262

6363
# info.permissionFound
6464

65-
Permission required: %s
65+
Permission required: %s
6666

6767
# info.requirementFound
6868

69-
Dependency found: %s
69+
Dependency found: %s
7070

7171
# info.fileScanned
7272

73-
Scanned: %s
73+
Scanned: %s
7474

7575
# info.scanCompleted
7676

@@ -160,4 +160,4 @@ Skip updating the requirements.txt file.
160160

161161
# flags.noRequirements.description
162162

163-
When set, only scans for permissions and updates config.json, but does not update the requirements.txt file with discovered dependencies.
163+
When set, only scans for permissions and updates config.json, but doesn't update the requirements.txt file with discovered dependencies.

messages/zip.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# summary
22

3-
Create a compressed archive of the Data Code Extension %s package
3+
Create a compressed archive of the Data Code Extension %s package.
44

55
# description
66

package.json

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,15 @@
4444
],
4545
"topics": {
4646
"data-code-extension": {
47-
"description": "Commands for Data Cloud Code Extension."
48-
},
49-
"data-code-extension script": {
50-
"description": "Initialize and manage script-based Data Cloud packages."
51-
},
52-
"data-code-extension function": {
53-
"description": "Initialize and manage function-based Data Cloud packages."
47+
"description": "Commands for Data Cloud Code Extension.",
48+
"subtopics": {
49+
"script": {
50+
"description": "Commands to initialize and manage script-based Data Cloud packages."
51+
},
52+
"function": {
53+
"description": "Commands to initialize and manage function-based Data Cloud packages."
54+
}
55+
}
5456
}
5557
},
5658
"flexibleTaxonomy": true

0 commit comments

Comments
 (0)