From 0f7f684b8630fb54f3f29546859d77f0fa5c17f9 Mon Sep 17 00:00:00 2001 From: rtmdk Date: Sat, 25 Mar 2017 00:58:32 -0700 Subject: [PATCH] Fix some reST field lists in docstrings Probably the most common format for documenting arguments is reST field lists [1]. This change updates some docstrings to comply with the field lists syntax [1] http://sphinx-doc.org/domains.html#info-field-lists Change-Id: I783202f2896acd3c2aee5a7408664b3008fa8854 --- neutron/db/quota/driver.py | 6 +++--- neutron/plugins/ml2/driver_api.py | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/neutron/db/quota/driver.py b/neutron/db/quota/driver.py index 156570915c4..3b9a93a9c5f 100644 --- a/neutron/db/quota/driver.py +++ b/neutron/db/quota/driver.py @@ -40,7 +40,7 @@ class DbQuotaDriver(object): :param context: The request context, for access checks. :param resources: A dictionary of the registered resource keys. :param tenant_id: The ID of the tenant to return default quotas for. - :return dict: from resource name to dict of name and limit + :return: dict from resource name to dict of name and limit """ # Currently the tenant_id parameter is unused, since all tenants # share the same default values. This may change in the future so @@ -58,7 +58,7 @@ class DbQuotaDriver(object): :param context: The request context, for access checks. :param resources: A dictionary of the registered resource keys. :param tenant_id: The ID of the tenant to return quotas for. - :return dict: from resource name to dict of name and limit + :return: dict from resource name to dict of name and limit """ # init with defaults @@ -96,7 +96,7 @@ class DbQuotaDriver(object): :param context: The request context, for access checks. :param resources: A dictionary of the registered resource keys. - :return quotas: list of dict of tenant_id:, resourcekey1: + :return: quotas list of dict of tenant_id:, resourcekey1: resourcekey2: ... """ tenant_default = dict((key, resource.default) diff --git a/neutron/plugins/ml2/driver_api.py b/neutron/plugins/ml2/driver_api.py index cbc1444442e..89a38167d79 100644 --- a/neutron/plugins/ml2/driver_api.py +++ b/neutron/plugins/ml2/driver_api.py @@ -88,7 +88,7 @@ class _TypeDriverBase(object): def get_mtu(self, physical): """Get driver's network MTU. - :returns mtu: maximum transmission unit + :returns: mtu maximum transmission unit Returns the mtu for the network based on the config values and the network type.