From 6a86f45b39f8e79bf07c09245f9c56aa46438901 Mon Sep 17 00:00:00 2001 From: TerryHowe Date: Fri, 20 Feb 2015 10:39:27 -0700 Subject: [PATCH] Fix up the limits documentation Change-Id: I924cda5ae570c69db9100acc4c897fcbfb29f4fb --- doc/source/users/resources/compute/index.rst | 3 +- .../users/resources/compute/v2/limits.rst | 28 +++++++++++++++++++ .../resources/compute/v2/limits_absolute.rst | 12 -------- .../resources/compute/v2/limits_rate.rst | 12 -------- openstack/compute/v2/limits.py | 4 +-- 5 files changed, 31 insertions(+), 28 deletions(-) create mode 100644 doc/source/users/resources/compute/v2/limits.rst delete mode 100644 doc/source/users/resources/compute/v2/limits_absolute.rst delete mode 100644 doc/source/users/resources/compute/v2/limits_rate.rst diff --git a/doc/source/users/resources/compute/index.rst b/doc/source/users/resources/compute/index.rst index 0bcd2c503..1731a574c 100644 --- a/doc/source/users/resources/compute/index.rst +++ b/doc/source/users/resources/compute/index.rst @@ -8,8 +8,7 @@ Compute Resources v2/flavor v2/image v2/keypair - v2/limits_absolute - v2/limits_rate + v2/limits v2/server v2/server_interface v2/server_ip diff --git a/doc/source/users/resources/compute/v2/limits.rst b/doc/source/users/resources/compute/v2/limits.rst new file mode 100644 index 000000000..ecea1f946 --- /dev/null +++ b/doc/source/users/resources/compute/v2/limits.rst @@ -0,0 +1,28 @@ +openstack.compute.v2.limits +=========================== + +.. automodule:: openstack.compute.v2.limits + +The Limits Class +---------------- + +The ``Limits`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.compute.v2.limits.Limits + :members: + +The AbsoluteLimits Class +------------------------ + +The ``AbsoluteLimits`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.compute.v2.limits.AbsoluteLimits + :members: + +The RateLimits Class +-------------------- + +The ``RateLimits`` class inherits from :class:`~openstack.resource.Resource`. + +.. autoclass:: openstack.compute.v2.limits.RateLimits + :members: diff --git a/doc/source/users/resources/compute/v2/limits_absolute.rst b/doc/source/users/resources/compute/v2/limits_absolute.rst deleted file mode 100644 index aac5598af..000000000 --- a/doc/source/users/resources/compute/v2/limits_absolute.rst +++ /dev/null @@ -1,12 +0,0 @@ -openstack.compute.v2.limits_absolute -==================================== - -.. automodule:: openstack.compute.v2.limits_absolute - -The LimitsAbsolute Class ------------------------- - -The ``LimitsAbsolute`` class inherits from :class:`~openstack.resource.Resource`. - -.. autoclass:: openstack.compute.v2.limits_absolute.LimitsAbsolute - :members: diff --git a/doc/source/users/resources/compute/v2/limits_rate.rst b/doc/source/users/resources/compute/v2/limits_rate.rst deleted file mode 100644 index 410f99e5e..000000000 --- a/doc/source/users/resources/compute/v2/limits_rate.rst +++ /dev/null @@ -1,12 +0,0 @@ -openstack.compute.v2.limits_rate -================================ - -.. automodule:: openstack.compute.v2.limits_rate - -The LimitsRate Class --------------------- - -The ``LimitsRate`` class inherits from :class:`~openstack.resource.Resource`. - -.. autoclass:: openstack.compute.v2.limits_rate.LimitsRate - :members: diff --git a/openstack/compute/v2/limits.py b/openstack/compute/v2/limits.py index 529ed1de4..1a78c4f3f 100644 --- a/openstack/compute/v2/limits.py +++ b/openstack/compute/v2/limits.py @@ -16,7 +16,7 @@ from openstack import resource class AbsoluteLimits(resource.Resource): - #: The maximum amount of key-value pairs to be set as image metadata. + #: The number of key-value pairs that can be set as image metadata. image_meta = resource.prop("maxImageMeta") #: The maximum number of personality contents that can be supplied. personality = resource.prop("maxPersonality") @@ -28,7 +28,7 @@ class AbsoluteLimits(resource.Resource): security_groups = resource.prop("maxSecurityGroups") #: The amount of security groups currently in use. security_groups_used = resource.prop("totalSecurityGroupsUsed") - #: The maximum amount of key-value pairs to be set as sever metadata. + #: The number of key-value pairs that can be set as sever metadata. server_meta = resource.prop("maxServerMeta") #: The maximum amount of cores. total_cores = resource.prop("maxTotalCores")