neutron-lib public APIs missing docstring

[Boden R]

As per our neutron-lib guidelines [1], we'd like to have all public APIs documented via docstrings. Today we have a handful that are missing docs. This is just a tracking bug to get our existing neutron-lib public APIs docstringed.

[1] https://github.com/openstack/neutron-lib/blob/master/doc/source/review-guidelines.rst

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/357403

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/357417

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/357429

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/357403
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=52d4875c791c63954c5956509545461f252e9de8
Submitter: Jenkins
Branch: master

commit 52d4875c791c63954c5956509545461f252e9de8
Author: Boden R <email address hidden>
Date: Thu Aug 18 12:08:59 2016 -0600

    Add docstrings for exceptions

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    Partial-Bug: #1614594

    Change-Id: Ic0fdc5c77abcbb77a7ca08e4e00302a22ae8e4f5

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/357429
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=756e02ee3e10c90ac4c0909374ed6c9acfbbb2ac
Submitter: Jenkins
Branch: master

commit 756e02ee3e10c90ac4c0909374ed6c9acfbbb2ac
Author: Boden R <email address hidden>
Date: Thu Aug 18 13:35:32 2016 -0600

    Add docstrings for converters

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    Change-Id: Id3a82f106d2504ac3d990fe2101b3ca2bb28f19d
    Partial-Bug: #1614594

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/358088

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/358097

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/358880

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/358885

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/358887

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/358890

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/358892

[OpenStack Infra (hudson-openstack)]

Fix proposed to branch: master
Review: https://review.openstack.org/358894

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358887
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=e86df3b3f396d958583d6499171a5baa70b70377
Submitter: Jenkins
Branch: master

commit e86df3b3f396d958583d6499171a5baa70b70377
Author: Boden R <email address hidden>
Date: Mon Aug 22 16:29:40 2016 -0600

    Add docstrings for utils.file

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    Change-Id: Icc65349e1d2b32cefbe0dc8472ca7f0c68c9a7f9
    Partial-Bug: #1614594

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358890
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=ee03dc1a1a4df328e3556bdd0d31e22b061724b4
Submitter: Jenkins
Branch: master

commit ee03dc1a1a4df328e3556bdd0d31e22b061724b4
Author: Boden R <email address hidden>
Date: Mon Aug 22 16:43:50 2016 -0600

    Add docstrings for utils.helpers

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    Change-Id: I11c23e3be430daa3e618904db4b4016105c7fc04
    Partial-Bug: #1614594

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358885
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=f54d49afbb8dbe584a4f3b54ea29e87717cb8946
Submitter: Jenkins
Branch: master

commit f54d49afbb8dbe584a4f3b54ea29e87717cb8946
Author: Boden R <email address hidden>
Date: Mon Aug 22 16:23:51 2016 -0600

    Add docstrings for hacking.translation_checks

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    For hacking checks we use the pep8 docstring format [1] so
    that the pep8 check codes can be auto-detected by pep8.
    I've manually tested neutron-lib master + this change with
    neutron master to ensure pep8 for neutron has no impacts.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    [1] https://github.com/PyCQA/pycodestyle/blob/1.5.7/pep8.py#L100

    Change-Id: I5301c105b60a4f61e2a220d0eb11c611a367c1cf
    Partial-Bug: #1614594

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358892
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=0f80b98b035622913de578161abe524dc4e90957
Submitter: Jenkins
Branch: master

commit 0f80b98b035622913de578161abe524dc4e90957
Author: Boden R <email address hidden>
Date: Mon Aug 22 16:46:13 2016 -0600

    Add docstrings for utils.host

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    Change-Id: Ib848349ae8f7497aa9f2646e8db20c26aa4f3d8c
    Partial-Bug: #1614594

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358880
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=4a9f24b523e342b018ab9012bf041df8bba48c94
Submitter: Jenkins
Branch: master

commit 4a9f24b523e342b018ab9012bf041df8bba48c94
Author: Boden R <email address hidden>
Date: Mon Aug 22 16:08:22 2016 -0600

    Add docstrings for hacking.checks

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    For hacking checks we use the pep8 docstring format [1] so
    that the pep8 check codes can be auto-detected by pep8.
    I've manually tested neutron-lib master + this change with
    neutron master to ensure pep8 for neutron has no impacts.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    [1] https://github.com/PyCQA/pycodestyle/blob/1.5.7/pep8.py#L100

    Change-Id: I0b7c068ee33c0199ea550c1ecdb4dd34fc40140a
    Partial-Bug: #1614594

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358097
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=5cbb6f7731f10b1c0929d12165aba701cbdb77fe
Submitter: Jenkins
Branch: master

commit 5cbb6f7731f10b1c0929d12165aba701cbdb77fe
Author: Boden R <email address hidden>
Date: Fri Aug 19 13:46:11 2016 -0600

    Add docstrings for db.utils

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    Change-Id: I1490e6b69e62617d3d29bd9e0eb8eb0f76ab5cc6
    Partial-Bug: #1614594

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/357417
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=610eb076a0de33b96129bf5db44050b5f0a3fa46
Submitter: Jenkins
Branch: master

commit 610eb076a0de33b96129bf5db44050b5f0a3fa46
Author: Boden R <email address hidden>
Date: Thu Aug 18 13:05:24 2016 -0600

    Add docstrings for policy

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    Change-Id: Ib157d8f44a3fc7118d568e84c3c351c885cfc8e8
    Partial-Bug: #1614594

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358894
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=5fbbfcc2d35cc120b3b22b4b5f11bacad0c1e778
Submitter: Jenkins
Branch: master

commit 5fbbfcc2d35cc120b3b22b4b5f11bacad0c1e778
Author: Boden R <email address hidden>
Date: Mon Aug 22 16:48:03 2016 -0600

    Add docstrings for utils.net

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    Change-Id: I3d51dfec0526062ecfad527121e3fa37387c22db
    Closes-Bug: #1614594

[Davanum Srinivas (DIMS) (dims-v)]

This issue was fixed in the openstack/neutron-lib 0.4.0 release.

[OpenStack Infra (hudson-openstack)]

Reviewed: https://review.openstack.org/358088
Committed: https://git.openstack.org/cgit/openstack/neutron-lib/commit/?id=00439e932a55b0ccca27e8584c73ea6b00682f16
Submitter: Jenkins
Branch: master

commit 00439e932a55b0ccca27e8584c73ea6b00682f16
Author: Boden R <email address hidden>
Date: Fri Aug 19 13:29:28 2016 -0600

    Add docstrings for api.validators

    Cleaning up a little technical debt by adding docstrings
    for our public APIs.

    Note: I plan to submit a patch per file as part of this bug work.
    These patches won't depend on each other. The last patch of
    the series will close the bug.

    Change-Id: I0f91f69f4db673c109cf993ec46df6f8dd1422b5
    Partial-Bug: #1614594

[OpenStack Infra (hudson-openstack)]

This issue was fixed in the openstack/neutron-lib 0.4.0 release.