← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1614594] Re: neutron-lib public APIs missing docstring

 

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 <bodenvmw@xxxxxxxxx>
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


** Changed in: neutron
       Status: In Progress => Fix Released

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to neutron.
https://bugs.launchpad.net/bugs/1614594

Title:
  neutron-lib public APIs missing docstring

Status in neutron:
  Fix Released

Bug description:
  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

To manage notifications about this bug go to:
https://bugs.launchpad.net/neutron/+bug/1614594/+subscriptions


References