openstack/python-ironicclient
Code Issues Proposed changes

Turn on warning-is-error

Browse Source 
In the doc-migration, warning-is-error was never enabled
for python-ironicclient. As such, I've enabled it and
corrected the various document errors.

Change-Id: I2d1b95fba25dba5d59da3f4b09b9974ff5196940
This commit is contained in:
Julia Kreger 2017-07-26 12:50:07 +00:00
parent ca1b923f98
commit 835c5d4c57
4 changed files with 13 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
doc/source/cli/ironic_client.rst
View File

@ -23,9 +23,9 @@ OpenStack Bare Metal Service (Ironic).
In order to use the CLI, you must provide your OpenStack username, password,
project (historically called tenant), and auth endpoint. You can use
configuration options :option:`--os-username`, :option:`--os-password`,
:option:`--os-tenant-id` (or :option:`--os-tenant-name`),
and :option:`--os-auth-url`, or set the corresponding
configuration options ``--os-username``, ``--os-password``,
``--os-tenant-id`` (or ``--os-tenant-name``),
and ``--os-auth-url``, or set the corresponding
environment variables::
$ export OS_USERNAME=user
@ -36,15 +36,15 @@ environment variables::
The command-line tool will attempt to reauthenticate using the provided
credentials for every request. You can override this behavior by manually
supplying an auth token using :option:`--ironic-url` and
:option:`--os-auth-token`, or by setting the corresponding environment
supplying an auth token using ``--ironic-url`` and
``--os-auth-token``, or by setting the corresponding environment
variables::
$ export IRONIC_URL=http://ironic.example.org:6385/
$ export OS_AUTH_TOKEN=3bcc3d3a03f44e3d8377f9247b0ad155
Since Keystone can return multiple regions in the Service Catalog, you can
specify the one you want with :option:`--os-region-name` or set the following
specify the one you want with ``--os-region-name`` or set the following
environment variable. (It defaults to the first in the list returned.)
::

4
doc/source/cli/osc_plugin_cli.rst
View File

@ -25,8 +25,8 @@ To use ``openstack`` CLI, the OpenStackClient should be installed::
To use the CLI, you must provide your OpenStack username, password,
project, and auth endpoint. You can use configuration options
:option:`--os-username`, :option:`--os-password`, :option:`--os-project-id`
(or :option:`--os-project-name`), and :option:`--os-auth-url`,
``--os-username``, ``--os-password``, ``--os-project-id``
(or ``--os-project-name``), and ``--os-auth-url``,
or set the corresponding environment variables::
$ export OS_USERNAME=user

8
ironicclient/v1/node.py
View File

@ -376,8 +376,8 @@ class NodeManager(base.CreateManager):
def vif_attach(self, node_ident, vif_id, **kwargs):
"""Attach VIF to a given node.
param node_ident: The UUID or Name of the node.
param vif_id: The UUID or Name of the VIF to attach.
:param node_ident: The UUID or Name of the node.
:param vif_id: The UUID or Name of the VIF to attach.
:param kwargs: A dictionary containing the attributes of the resource
that will be created.
"""
@ -393,8 +393,8 @@ class NodeManager(base.CreateManager):
def vif_detach(self, node_ident, vif_id):
"""Detach VIF from a given node.
param node_ident: The UUID or Name of the node.
param vif_id: The UUID or Name of the VIF to detach.
:param node_ident: The UUID or Name of the node.
:param vif_id: The UUID or Name of the VIF to detach.
"""
path = "%s/vifs/%s" % (node_ident, vif_id)
self.delete(path)

1
setup.cfg
View File

@ -112,6 +112,7 @@ warnerrors = True
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[wheel]
universal = 1