Skip to content

Commit ae44107

Browse files
authored
docs(cockpit): clean up global api doc (#4653)
1 parent c27dbbc commit ae44107

File tree

5 files changed

+9
-9
lines changed

5 files changed

+9
-9
lines changed

cmd/scw/testdata/test-all-usage-cockpit-plan-get-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
33
Retrieve a pricing plan for the given Project, specified by the ID of the Project.
4-
Deprecated, retention is now managed at the data source level.
4+
Deprecated: retention is now managed at the data source level.
55

66
USAGE:
77
scw cockpit plan get [arg=value ...]

cmd/scw/testdata/test-all-usage-cockpit-plan-list-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
33
Retrieve a list of available pricing plan types.
4-
Deprecated, retention is now managed at the data source level.
4+
Deprecated: retention is now managed at the data source level.
55

66
USAGE:
77
scw cockpit plan list [arg=value ...]

cmd/scw/testdata/test-all-usage-cockpit-plan-select-usage.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
🎲🎲🎲 EXIT CODE: 0 🎲🎲🎲
22
🟥🟥🟥 STDERR️️ 🟥🟥🟥️
33
Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
4-
Deprecated, retention is now managed at the data source level.
4+
Deprecated: retention is now managed at the data source level.
55

66
USAGE:
77
scw cockpit plan select [arg=value ...]

docs/commands/cockpit.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ Pricing plans management commands.
484484
### Get current plan
485485

486486
Retrieve a pricing plan for the given Project, specified by the ID of the Project.
487-
Deprecated, retention is now managed at the data source level.
487+
Deprecated: retention is now managed at the data source level.
488488

489489
**Usage:**
490490

@@ -504,7 +504,7 @@ scw cockpit plan get [arg=value ...]
504504
### List plan types
505505

506506
Retrieve a list of available pricing plan types.
507-
Deprecated, retention is now managed at the data source level.
507+
Deprecated: retention is now managed at the data source level.
508508

509509
**Usage:**
510510

@@ -524,7 +524,7 @@ scw cockpit plan list [arg=value ...]
524524
### Apply a pricing plan
525525

526526
Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
527-
Deprecated, retention is now managed at the data source level.
527+
Deprecated: retention is now managed at the data source level.
528528

529529
**Usage:**
530530

internal/namespaces/cockpit/v1/cockpit_cli.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -428,7 +428,7 @@ func cockpitPlanList() *core.Command {
428428
return &core.Command{
429429
Short: `List plan types`,
430430
Long: `Retrieve a list of available pricing plan types.
431-
Deprecated, retention is now managed at the data source level.`,
431+
Deprecated: retention is now managed at the data source level.`,
432432
Namespace: "cockpit",
433433
Resource: "plan",
434434
Verb: "list",
@@ -462,7 +462,7 @@ func cockpitPlanSelect() *core.Command {
462462
return &core.Command{
463463
Short: `Apply a pricing plan`,
464464
Long: `Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
465-
Deprecated, retention is now managed at the data source level.`,
465+
Deprecated: retention is now managed at the data source level.`,
466466
Namespace: "cockpit",
467467
Resource: "plan",
468468
Verb: "select",
@@ -493,7 +493,7 @@ func cockpitPlanGet() *core.Command {
493493
return &core.Command{
494494
Short: `Get current plan`,
495495
Long: `Retrieve a pricing plan for the given Project, specified by the ID of the Project.
496-
Deprecated, retention is now managed at the data source level.`,
496+
Deprecated: retention is now managed at the data source level.`,
497497
Namespace: "cockpit",
498498
Resource: "plan",
499499
Verb: "get",

0 commit comments

Comments
 (0)