Skip to content

Commit 3ec0ee4

Browse files
author
Phil Rzewski
committed
Fix references to functions within docstrings so they become links again
1 parent 7123f16 commit 3ec0ee4

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

sdcclient/_client.py

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ def update_notification_resolution(self, notification, resolved):
151151
Updates the resolution status of an alert notification.
152152
153153
**Arguments**
154-
- **notification**: notification object as returned by :func:`~sdcclient._client.SdcClient.get_notifications`.
154+
- **notification**: notification object as returned by :func:`~SdcClient.get_notifications`.
155155
- **resolved**: new resolution status. Supported values are ``True`` and ``False``.
156156
157157
**Success Return Value**
@@ -292,7 +292,7 @@ def delete_alert(self, alert):
292292
Deletes an alert.
293293
294294
**Arguments**
295-
- **alert**: the alert dictionary as returned by :func:`~sdcclient._client.SdcClient.get_alerts`.
295+
- **alert**: the alert dictionary as returned by :func:`~SdcClient.get_alerts`.
296296
297297
**Success Return Value**
298298
``None``.
@@ -410,7 +410,7 @@ def set_explore_grouping_hierarchy(self, new_hierarchy):
410410

411411
def get_data_retention_info(self):
412412
'''**Description**
413-
Return the list of data retention intervals, with beginning and end UTC time for each of them. Sysdig Cloud performs rollups of the data it stores. This means that data is stored at different time granularities depending on how far back in time it is. This call can be used to know what precision you can expect before you make a call to :func:`~sdcclient._client.SdcClient.get_data`.
413+
Return the list of data retention intervals, with beginning and end UTC time for each of them. Sysdig Cloud performs rollups of the data it stores. This means that data is stored at different time granularities depending on how far back in time it is. This call can be used to know what precision you can expect before you make a call to :func:`~SdcClient.get_data`.
414414
415415
**Success Return Value**
416416
A dictionary containing the list of available sampling intervals.
@@ -549,7 +549,7 @@ def get_dashboards(self):
549549

550550
def find_dashboard_by(self, name=None):
551551
'''**Description**
552-
Finds dashboards with the specified name. You can then delete the dashboard (with :func:`~sdcclient._client.SdcClient.delete_dashboard`) or edit panels (with :func:`~sdcclient._client.SdcClient.add_dashboard_panel` and :func:`~sdcclient._client.SdcClient.remove_dashboard_panel`)
552+
Finds dashboards with the specified name. You can then delete the dashboard (with :func:`~SdcClient.delete_dashboard`) or edit panels (with :func:`~SdcClient.add_dashboard_panel` and :func:`~SdcClient.remove_dashboard_panel`)
553553
554554
**Arguments**
555555
- **name**: the name of the dashboards to find.
@@ -1002,7 +1002,7 @@ def create_dashboard_from_file(self, newdashname, filename, filter, shared=False
10021002
10031003
**Arguments**
10041004
- **newdashname**: the name of the dashboard that will be created.
1005-
- **filename**: name of a file containing a JSON object for a dashboard in the format of an array element returned by :func:`~sdcclient._client.SdcClient.get_dashboards`
1005+
- **filename**: name of a file containing a JSON object for a dashboard in the format of an array element returned by :func:`~SdcClient.get_dashboards`
10061006
- **filter**: a boolean expression combining Sysdig Cloud segmentation criteria defines what the new dasboard will be applied to. For example: *kubernetes.namespace.name='production' and container.image='nginx'*.
10071007
- **shared**: if set to True, the new dashboard will be a shared one.
10081008
- **annotations**: an optional dictionary of custom properties that you can associate to this dashboard for automation or management reasons
@@ -1032,7 +1032,7 @@ def delete_dashboard(self, dashboard):
10321032
Deletes a dashboard.
10331033
10341034
**Arguments**
1035-
- **dashboard**: the dashboard object as returned by :func:`~sdcclient._client.SdcClient.get_dashboards`.
1035+
- **dashboard**: the dashboard object as returned by :func:`~SdcClient.get_dashboards`.
10361036
10371037
**Success Return Value**
10381038
`None`.
@@ -1130,7 +1130,7 @@ def delete_event(self, event):
11301130
Deletes an event.
11311131
11321132
**Arguments**
1133-
- **event**: the event object as returned by :func:`~sdcclient._client.SdcClient.get_events`.
1133+
- **event**: the event object as returned by :func:`~SdcClient.get_events`.
11341134
11351135
**Success Return Value**
11361136
`None`.
@@ -1228,10 +1228,10 @@ def get_sysdig_captures(self):
12281228

12291229
def poll_sysdig_capture(self, capture):
12301230
'''**Description**
1231-
Fetch the updated state of a sysdig capture. Can be used to poll the status of a capture that has been previously created and started with :func:`~sdcclient._client.SdcClient.create_sysdig_capture`.
1231+
Fetch the updated state of a sysdig capture. Can be used to poll the status of a capture that has been previously created and started with :func:`~SdcClient.create_sysdig_capture`.
12321232
12331233
**Arguments**
1234-
- **capture**: the capture object as returned by :func:`~sdcclient._client.SdcClient.get_sysdig_captures` or :func:`~sdcclient._client.SdcClient.create_sysdig_capture`.
1234+
- **capture**: the capture object as returned by :func:`~SdcClient.get_sysdig_captures` or :func:`~SdcClient.create_sysdig_capture`.
12351235
12361236
**Success Return Value**
12371237
A dictionary showing the updated details of the capture. Use the ``status`` field to check the progress of a capture.
@@ -1571,7 +1571,7 @@ def switch_user_team(self, new_team_id):
15711571
Switches the current user context to the specified team. In other words, this function makes it possible to start operating in the context of a different team without having to use the token of that team.
15721572
15731573
**Arguments**
1574-
- **new_team_id**: the numeric ID of the team (such as returned by :func:`~sdcclient._client.SdcClient.get_team_ids`) to switch to.
1574+
- **new_team_id**: the numeric ID of the team (such as returned by :func:`~SdcClient.get_team_ids`) to switch to.
15751575
'''
15761576
res = self.get_user_info()
15771577
if not res[0]:

0 commit comments

Comments
 (0)