openstack/openstacksdk
Code Issues Proposed changes

Merge "Reindentation of the docstrings" into feature/r1

Browse Source
This commit is contained in:
Zuul 2021-10-22 21:24:15 +00:00 committed by Gerrit Code Review
commit 433d2d8902
1 changed files with 37 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
openstack/instance_ha/v1/_proxy.py
View File

@ -39,11 +39,10 @@ class Proxy(proxy.Proxy):
"""Get a single notification.
:param notification: The value can be the ID of a notification or a
:class:
`~masakariclient.sdk.ha.v1
.notification.Notification` instance.
:returns: One :class:`~masakariclient.sdk.ha.v1
.notification.Notification`
:class: `~masakariclient.sdk.ha.v1.notification.Notification`
instance.
:returns: One
:class:`~masakariclient.sdk.ha.v1.notification.Notification`
:raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found.
"""
@ -53,14 +52,10 @@ class Proxy(proxy.Proxy):
"""Create a new notification.
:param dict attrs: Keyword arguments which will be used to create
a :class:
`masakariclient.sdk.ha.v1
.notification.Notification`,
comprised of the propoerties on the Notification
class.
a :class:`masakariclient.sdk.ha.v1.notification.Notification`,
comprised of the propoerties on the Notification class.
:returns: The result of notification creation
:rtype: :class: `masakariclient.sdk.ha.v1
.notification.Notification`
:rtype: :class: `masakariclient.sdk.ha.v1.notification.Notification`
"""
return self._create(_notification.Notification, **attrs)
@ -77,8 +72,7 @@ class Proxy(proxy.Proxy):
"""Get a single segment.
:param segment: The value can be the ID of a segment or a
:class:
`~masakariclient.sdk.ha.v1.segment.Segment` instance.
:class: `~masakariclient.sdk.ha.v1.segment.Segment` instance.
:returns: One :class:`~masakariclient.sdk.ha.v1.segment.Segment`
:raises: :class:`~openstack.exceptions.ResourceNotFound`
when no resource can be found.
@ -89,8 +83,7 @@ class Proxy(proxy.Proxy):
"""Create a new segment.
:param dict attrs: Keyword arguments which will be used to create
a :class:
`masakariclient.sdk.ha.v1.segment.Segment`,
a :class: `masakariclient.sdk.ha.v1.segment.Segment`,
comprised of the propoerties on the Segment class.
:returns: The result of segment creation
:rtype: :class: `masakariclient.sdk.ha.v1.segment.Segment`
@ -101,11 +94,9 @@ class Proxy(proxy.Proxy):
"""Update a segment.
:param segment: The value can be the ID of a segment or a
:class:
`~masakariclient.sdk.ha.v1.segment.Segment` instance.
:class: `~masakariclient.sdk.ha.v1.segment.Segment` instance.
:param dict attrs: Keyword arguments which will be used to update
a :class:
`masakariclient.sdk.ha.v1.segment.Segment`,
a :class: `masakariclient.sdk.ha.v1.segment.Segment`,
comprised of the propoerties on the Segment class.
:returns: The updated segment.
:rtype: :class: `masakariclient.sdk.ha.v1.segment.Segment`