openstack/oslo.policy
Code Issues Proposed changes

Use Sphinx 1.5 warning-is-error

Browse Source 
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section.  Migrate the
setting from the old warnerrors one.

There are some invalid docstrings. These are cleaned up.

Change-Id: Ic6a028bab428b23255f36e5b2d64ee8d4d32978d
This commit is contained in:
Stephen Finucane 2017-03-16 15:42:44 +00:00
parent 3951771456
commit 886d8c6dab
2 changed files with 19 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
oslo_policy/policy.py
View File

@ -127,10 +127,11 @@ attributes obtained through a token:
- domain_id or project_id (depending on the token scope) - domain_id or project_id (depending on the token scope)
- list of roles held for the given token scope - list of roles held for the given token scope
.. note:: Some resources which are exposed by the API do not support policy .. note::
enforcement by user_id, and only support policy enforcement by project_id. Some resources which are exposed by the API do not support policy
Some global resources do not support policy enforcement by combination of enforcement by user_id, and only support policy enforcement by project_id.
user_id and project_id. Some global resources do not support policy enforcement by combination of
user_id and project_id.
For example, a check on the user_id would be defined as:: For example, a check on the user_id would be defined as::
@ -204,10 +205,10 @@ using the :func:`~oslo_policy.policy.register` function.
The following classes can be used as parents for custom special check types: The following classes can be used as parents for custom special check types:
* :class:`~oslo_policy.policy.AndCheck` * :class:`~oslo_policy.policy.AndCheck`
* :class:`~oslo_policy.policy.NotCheck` * :class:`~oslo_policy.policy.NotCheck`
* :class:`~oslo_policy.policy.OrCheck` * :class:`~oslo_policy.policy.OrCheck`
* :class:`~oslo_policy.policy.RuleCheck` * :class:`~oslo_policy.policy.RuleCheck`
Default Rule Default Rule
~~~~~~~~~~~~ ~~~~~~~~~~~~
@ -851,11 +852,12 @@ class DocumentedRuleDefault(RuleDefault):
converted to use DocumentedRuleDefault. converted to use DocumentedRuleDefault.
:param operations: List of dicts containing each api url and :param operations: List of dicts containing each api url and
corresponding http request method. corresponding http request method.
Example: Example::
operations=[{'path': '/foo', 'method': 'GET'},
{'path': '/some', 'method': 'POST'}] operations=[{'path': '/foo', 'method': 'GET'},
{'path': '/some', 'method': 'POST'}]
""" """
def __init__(self, name, check_str, description, operations): def __init__(self, name, check_str, description, operations):
super(DocumentedRuleDefault, self).__init__( super(DocumentedRuleDefault, self).__init__(

7
setup.cfg
View File

@ -23,8 +23,10 @@ packages =
oslo_policy oslo_policy
[pbr] [pbr]
warnerrors = true
autodoc_tree_index_modules = True autodoc_tree_index_modules = True
autodoc_tree_excludes =
setup.py
oslo_policy/tests/
[entry_points] [entry_points]
oslo.config.opts = oslo.config.opts =
@ -37,9 +39,10 @@ console_scripts =
oslopolicy-list-redundant = oslo_policy.generator:list_redundant oslopolicy-list-redundant = oslo_policy.generator:list_redundant
[build_sphinx] [build_sphinx]
all-files = 1
warning-is-error = 1
source-dir = doc/source source-dir = doc/source
build-dir = doc/build build-dir = doc/build
all_files = 1
[upload_sphinx] [upload_sphinx]
upload-dir = doc/build/html upload-dir = doc/build/html