Skip to content

Commit 87a34b1

Browse files
authored
docs(cockpit): clean up global api doc (#947)
1 parent b3ba131 commit 87a34b1

File tree

2 files changed

+10
-10
lines changed
  • scaleway-async/scaleway_async/cockpit/v1
  • scaleway/scaleway/cockpit/v1

2 files changed

+10
-10
lines changed

scaleway-async/scaleway_async/cockpit/v1/api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494

9595
class CockpitV1GlobalAPI(API):
9696
"""
97-
The Cockpit Global API allows you to manage your Cockpit's Grafana and plans.
97+
The Cockpit Global API allows you to manage your Cockpit's Grafana.
9898
"""
9999

100100
async def get_grafana(
@@ -454,7 +454,7 @@ async def list_plans(
454454
"""
455455
List plan types.
456456
Retrieve a list of available pricing plan types.
457-
Deprecated, retention is now managed at the data source level.
457+
Deprecated: retention is now managed at the data source level.
458458
:param page: Page number.
459459
:param page_size: Page size.
460460
:param order_by:
@@ -490,7 +490,7 @@ async def list_plans_all(
490490
"""
491491
List plan types.
492492
Retrieve a list of available pricing plan types.
493-
Deprecated, retention is now managed at the data source level.
493+
Deprecated: retention is now managed at the data source level.
494494
:param page: Page number.
495495
:param page_size: Page size.
496496
:param order_by:
@@ -523,7 +523,7 @@ async def select_plan(
523523
"""
524524
Apply a pricing plan.
525525
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.
526-
Deprecated, retention is now managed at the data source level.
526+
Deprecated: retention is now managed at the data source level.
527527
:param project_id: ID of the Project.
528528
:param plan_name: Name of the pricing plan.
529529
:return: :class:`Plan <Plan>`
@@ -558,7 +558,7 @@ async def get_current_plan(
558558
"""
559559
Get current plan.
560560
Retrieve a pricing plan for the given Project, specified by the ID of the Project.
561-
Deprecated, retention is now managed at the data source level.
561+
Deprecated: retention is now managed at the data source level.
562562
:param project_id: ID of the Project.
563563
:return: :class:`Plan <Plan>`
564564
:deprecated

scaleway/scaleway/cockpit/v1/api.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@
9494

9595
class CockpitV1GlobalAPI(API):
9696
"""
97-
The Cockpit Global API allows you to manage your Cockpit's Grafana and plans.
97+
The Cockpit Global API allows you to manage your Cockpit's Grafana.
9898
"""
9999

100100
def get_grafana(
@@ -454,7 +454,7 @@ def list_plans(
454454
"""
455455
List plan types.
456456
Retrieve a list of available pricing plan types.
457-
Deprecated, retention is now managed at the data source level.
457+
Deprecated: retention is now managed at the data source level.
458458
:param page: Page number.
459459
:param page_size: Page size.
460460
:param order_by:
@@ -490,7 +490,7 @@ def list_plans_all(
490490
"""
491491
List plan types.
492492
Retrieve a list of available pricing plan types.
493-
Deprecated, retention is now managed at the data source level.
493+
Deprecated: retention is now managed at the data source level.
494494
:param page: Page number.
495495
:param page_size: Page size.
496496
:param order_by:
@@ -523,7 +523,7 @@ def select_plan(
523523
"""
524524
Apply a pricing plan.
525525
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.
526-
Deprecated, retention is now managed at the data source level.
526+
Deprecated: retention is now managed at the data source level.
527527
:param project_id: ID of the Project.
528528
:param plan_name: Name of the pricing plan.
529529
:return: :class:`Plan <Plan>`
@@ -558,7 +558,7 @@ def get_current_plan(
558558
"""
559559
Get current plan.
560560
Retrieve a pricing plan for the given Project, specified by the ID of the Project.
561-
Deprecated, retention is now managed at the data source level.
561+
Deprecated: retention is now managed at the data source level.
562562
:param project_id: ID of the Project.
563563
:return: :class:`Plan <Plan>`
564564
:deprecated

0 commit comments

Comments
 (0)