<html><body>
<p><font size="2" face="sans-serif">fwiw - openstackclient has been using .. versionadded:: in it's docs for a while:</font><br>
<a href="http://docs.openstack.org/developer/python-openstackclient/_sources/command-objects/user.txt"><font size="2" face="sans-serif">http://docs.openstack.org/developer/python-openstackclient/_sources/command-objects/user.txt</font></a><br>
<font size="2" face="sans-serif"><br>
Thanks,<br>
<br>
Steve Martinelli<br>
OpenStack Keystone Core</font><br>
<br>
<img width="16" height="16" src="cid:1__=0ABBF4E8DFCFD52B8f9e8a93df938@ca.ibm.com" border="0" alt="Inactive hide details for Victor Stinner ---2015/07/07 11:23:05 AM---Hi, Oslo libraries become more and more stable, cool :-) S"><font size="2" color="#424282" face="sans-serif">Victor Stinner ---2015/07/07 11:23:05 AM---Hi, Oslo libraries become more and more stable, cool :-) Sometimes, we have</font><br>
<br>
<font size="1" color="#5F5F5F" face="sans-serif">From:      </font><font size="1" face="sans-serif">Victor Stinner <vstinner@redhat.com></font><br>
<font size="1" color="#5F5F5F" face="sans-serif">To:        </font><font size="1" face="sans-serif">OpenStack List <openstack-dev@lists.openstack.org></font><br>
<font size="1" color="#5F5F5F" face="sans-serif">Date:      </font><font size="1" face="sans-serif">2015/07/07 11:23 AM</font><br>
<font size="1" color="#5F5F5F" face="sans-serif">Subject:   </font><font size="1" face="sans-serif">[openstack-dev] [oslo] Document API changes using Sphinx markups</font><br>
<hr width="100%" size="2" align="left" noshade style="color:#8091A5; "><br>
<br>
<br>
<tt><font size="2">Hi,<br>
<br>
Oslo libraries become more and more stable, cool :-) Sometimes, we have <br>
to modify APIs, to fix bugs, to deprecate functions, to add new function <br>
parameters, etc. It would be cool to _document_ these changes. Sphinx <br>
provides nice markups to document API changes:<br>
<br>
    </font></tt><tt><font size="2"><a href="http://sphinx-doc.org/markup/para.html">http://sphinx-doc.org/markup/para.html</a></font></tt><tt><font size="2"><br>
<br>
We can try to ensure that API changes are documented in reviews, or <br>
maybe also document old changes.<br>
<br>
Examples:<br>
<br>
.. versionadded:: 2.5<br>
    The *spam* parameter.<br>
<br>
.. versionadded:: 2.6<br>
    The function now returns an integer.<br>
<br>
.. deprecated:: 3.1<br>
    Use :func:`spam` instead.<br>
<br>
I noticed that the deprecated markup is already used in oslo.utils doc:<br>
<br>
</font></tt><tt><font size="2"><a href="http://docs.openstack.org/developer/oslo.utils/api/timeutils.html#oslo_utils.timeutils.isotime">http://docs.openstack.org/developer/oslo.utils/api/timeutils.html#oslo_utils.timeutils.isotime</a></font></tt><tt><font size="2"><br>
<br>
Victor<br>
<br>
__________________________________________________________________________<br>
OpenStack Development Mailing List (not for usage questions)<br>
Unsubscribe: OpenStack-dev-request@lists.openstack.org?subject:unsubscribe<br>
</font></tt><tt><font size="2"><a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-dev</a></font></tt><tt><font size="2"><br>
<br>
</font></tt><br>
<br>
</body></html>