x/rsd-lib
Code Issues Proposed changes

Fix indentation in docstrings

Browse Source 
When building documentation, wrong indentation in docstring warnings are
leading to doc build errors (warning-is-error is enabled).

This patch is fixing indentation for indentation in docstrings so that
sphinx can build the documentation without warnings.

Change-Id: I0fccf1b38747603027850473211ddb17224e45e3
This commit is contained in:
Alfredo Moralejo 2019-02-12 10:49:20 +01:00 committed by Lin Yang
parent c6433c2e61
commit 731994050a
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
rsd_lib/resources/v2_1/event_service/event_service.py
View File

@ -62,11 +62,11 @@ class EventService(base.ResourceBase):
event_types_for_subscription = base.Field("EventTypesForSubscription")
"""These are the types of Events that can be subscribed to. Available
event types:
- StatusChange - The status of this resource has changed
- ResourceUpdated - The value of this resource has been updated
- ResourceAdded - A resource has been added
- ResourceRemoved - A resource has been removed
- Alert - A condition exists which requires attention
- StatusChange - The status of this resource has changed
- ResourceUpdated - The value of this resource has been updated
- ResourceAdded - A resource has been added
- ResourceRemoved - A resource has been removed
- Alert - A condition exists which requires attention
"""
def __init__(self, connector, identity, redfish_version=None):

14
rsd_lib/resources/v2_1/event_service/event_subscription.py
View File

@ -48,11 +48,11 @@ class EventSubscription(base.ResourceBase):
event_types = base.Field("EventTypes")
"""These are the types of Events that can be subscribed to. Available
event types:
- StatusChange - The status of this resource has changed
- ResourceUpdated - The value of this resource has been updated.
- ResourceAdded - A resource has been added
- ResourceRemoved - A resource has been removed
- Alert - A condition exists which requires attention
- StatusChange - The status of this resource has changed
- ResourceUpdated - The value of this resource has been updated.
- ResourceAdded - A resource has been added
- ResourceRemoved - A resource has been removed
- Alert - A condition exists which requires attention
"""
context = base.Field("Context")
@ -62,8 +62,8 @@ class EventSubscription(base.ResourceBase):
protocol = base.Field("Protocol")
"""The protocol type of the event connection. Available protocols:
- "Redfish" - event type shall adhere to that defined in the
Redfish specification.
- "Redfish" - event type shall adhere to that defined in the \
Redfish specification.
"""
http_headers = base.Field("HttpHeaders")