When reviewing neutron-lib changes, please be aware:
When code is moved from neutron, please evaluate with the following criteria:
Public APIs should be documented using reST style docstrings that include an overview as well as parameter and return documentation. The format of docstrings can be found in the OpenStack developer hacking docs. Note that public API documentation is a bonus, not a requirement.
Public classes and methods must not be destructively changed without following the full OpenStack deprecation path.
For example, do not:
Alternatives:
Removing the code from neutron should include a shim in neutron for the sake of subprojects. Refer to neutron/common/exceptions.py for an example. Please Use oslo’s debtcollector library, example: http://docs.openstack.org/developer/debtcollector/
The above implies that if you add something, we are stuck with that interface for a long time, so be careful.
Any code that imports/uses the following python modules should not be moved into neutron-lib: