Hi,
Oslo libraries become more and more stable, cool :-) Sometimes, we have
to modify APIs, to fix bugs, to deprecate functions, to add new function
parameters, etc. It would be cool to _document_ these changes. Sphinx
provides nice markups to document API changes:
http://sphinx-doc.org/markup/para.html
We can try to ensure that API changes are documented in reviews, or
maybe also document old changes.
Examples:
.. versionadded:: 2.5
The *spam* parameter.
.. versionadded:: 2.6
The function now returns an integer.
.. deprecated:: 3.1
Use :func:`spam` instead.
I noticed that the deprecated markup is already used in oslo.utils doc:
http://docs.openstack.org/developer/oslo.utils/api/timeutils.html#oslo_utils.timeutils.isotime
Victor
__________________________________________________________________________
OpenStack Development Mailing List (not for usage questions)
Unsubscribe: [email protected]?subject:unsubscribe
http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev
