summaryrefslogtreecommitdiff
path: root/nova/policy.py
diff options
context:
space:
mode:
authorDoug Hellmann <doug.hellmann@dreamhost.com>2012-03-05 14:33:40 -0500
committerDoug Hellmann <doug.hellmann@dreamhost.com>2012-03-05 16:18:53 -0500
commitb1de27f68a9f80db723c1b3545f95c5c9c8e7e9d (patch)
tree13476ca8ca0cc0ed9667dfe9b0cc33fed61fc4b0 /nova/policy.py
parent5f9cee0c9c95b61d548730e7918e5c623301b3b1 (diff)
downloadnova-b1de27f68a9f80db723c1b3545f95c5c9c8e7e9d.tar.gz
fix restructuredtext formatting in docstrings that show up in the developer guide
blueprint sphinx-doc-cleanup bug 945160 - Correct parameter declarations, list formatting, cross-references, etc. - We don't need "let" in generate_autodoc_index.sh since we aren't doing math. - Change conf.py to not prefix class and function names with full namespace in generated output to save width on the screen. Change-Id: I9adc8681951913fd291d03e7142146e9d46841df
Diffstat (limited to 'nova/policy.py')
-rw-r--r--nova/policy.py10
1 files changed, 5 insertions, 5 deletions
diff --git a/nova/policy.py b/nova/policy.py
index 9f6e6c9e25..b9f81cf5b5 100644
--- a/nova/policy.py
+++ b/nova/policy.py
@@ -68,15 +68,15 @@ def enforce(context, action, target):
:param context: nova context
:param action: string representing the action to be checked
this should be colon separated for clarity.
- i.e. compute:create_instance
- compute:attach_volume
- volume:attach_volume
+ i.e. ``compute:create_instance``,
+ ``compute:attach_volume``,
+ ``volume:attach_volume``
:param object: dictionary representing the object of the action
for object creation this should be a dictionary representing the
- location of the object e.g. {'project_id': context.project_id}
+ location of the object e.g. ``{'project_id': context.project_id}``
- :raises: `nova.exception.PolicyNotAllowed` if verification fails.
+ :raises nova.exception.PolicyNotAllowed: if verification fails.
"""
init()