[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-22 Thread Fred L. Drake, Jr.
Fred L. Drake, Jr. added the comment: For anyone following along only via the tracker, it's worth noting that proposals for new markup are welcome on the docs mailing list. More information is available at: https://mail.python.org/mailman/listinfo/docs --

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-22 Thread Raymond Hettinger
Raymond Hettinger added the comment: Fred, thanks for chiming in. Let's do close this one. -- nosy: +rhettinger resolution: -> not a bug status: open -> closed ___ Python tracker

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-22 Thread Fred L. Drake, Jr.
Fred L. Drake, Jr. added the comment: If no one is planning to propose specific new markup for more fine-grained version annotations, this issue can be closed. -- ___ Python tracker

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-19 Thread Fred L. Drake, Jr.
Fred L. Drake, Jr. added the comment: Another reason to value the status-quo in this case is that this isn't just a matter for the Python documentation; it's about the recommended usage for the markup, which is used by many other packages. Questions that should be discussed include: 1. Should

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-19 Thread Tony R.
Tony R. added the comment: > Part of the problem is getting the granularity right. The initial intent was > that 'version*' were annotations for the enclosing object (function, class, > method, etc.). If we want to have something more granular (parameter > added / deprecated / whatever), we

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-19 Thread Georg Brandl
Georg Brandl added the comment: > Well then, if this is the sort of place where the status quo is sacred, > then there is nothing more to discuss. That wasn't my intention when quoting the old documenting guide, it was just to show what the intent was (and still is), and that I didn't just

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-19 Thread Fred L. Drake, Jr.
Fred L. Drake, Jr. added the comment: On Fri, Feb 19, 2016 at 10:02 AM, Tony R. wrote: > Holy crap! You all used to use LaTeX?! :D Python's documentation has a long & colorful history. :-) > Well then, if this is the sort of place where the status quo is sacred,

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-19 Thread Tony R.
Tony R. added the comment: > Here are the original descriptions of the old LaTeX version. Holy crap! You all used to use LaTeX?! :D (I know--LaTeX is still going strong in academia. I just had no idea it was ever part of Python’s documentation, except as an output format.) > Adding a

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-18 Thread Tony R.
Tony R. added the comment: > My weak opinion is that a new parameter is a new API item, not just a change > in behaviour, so should probably have “versionadded”. This was my reasoning as well. Also, when I noticed so many instances of ``.. versionchanged`` that all say “Added the *x*

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-16 Thread Berker Peksag
Berker Peksag added the comment: I agree with Georg and Ezio. We should update the devguide. Tony, would you like to propose a patch? The repo is at https://hg.python.org/devguide -- nosy: +berker.peksag ___ Python tracker

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-15 Thread Martin Panter
Martin Panter added the comment: If you changed existing versionadded notices to versionchanged in similar cases, how would the size of the patch compare? This problem was also recently brought up at . My

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-15 Thread Georg Brandl
Georg Brandl added the comment: The devguide should be updated, yes. And probably someone should look at the remaining versionadded's... -- ___ Python tracker

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-15 Thread Ezio Melotti
Ezio Melotti added the comment: I agree with Georg. I also went to double-check what the devguide says, and at https://docs.python.org/devguide/documenting.html#paragraph-level-markup it shows an example of versionadded for a parameter. If a versionchanged should be used instead, maybe the

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-15 Thread Georg Brandl
Georg Brandl added the comment: Hi Tony, thanks for the patch, and for the will to contribute. I'm not sure this patch should be merged though; the original intention was to use "versionadded" where the API item is completely new. So "The parameter x was added" in a function is using

[issue26366] Use “.. versionadded” over “.. versionchanged” where appropriate

2016-02-15 Thread Tony R.
New submission from Tony R.: In the documentation, I noticed several uses of ``.. versionchanged::`` that described things which had been added. I love Python, and its documentation, and I wanted to contribute. So, I figured a low-risk contribution would be to change ``..