-
-
Notifications
You must be signed in to change notification settings - Fork 18.5k
DOC: Remove versionadded/changed for 1.1.0 #52905
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
@@ -957,10 +957,6 @@ regarding :ref:`documentation <contributing_documentation>`. | |||
Further, to let users know when this feature was added, the ``versionadded`` | |||
directive is used. The sphinx syntax for that is: | |||
|
|||
.. code-block:: rst | |||
|
|||
.. versionadded:: 1.1.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we want to keep this as an example of how to add this sphinx syntax. Might be good to just update the version (and the sentence below)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed, like 2.1.0
(and update the "This will put the text New in version 1.1.0" text below)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, should have read in more detail
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
just one comment, rest looks good
@@ -957,10 +957,6 @@ regarding :ref:`documentation <contributing_documentation>`. | |||
Further, to let users know when this feature was added, the ``versionadded`` | |||
directive is used. The sphinx syntax for that is: | |||
|
|||
.. code-block:: rst | |||
|
|||
.. versionadded:: 1.1.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
agreed, like 2.1.0
(and update the "This will put the text New in version 1.1.0" text below)
.. versionchanged:: 1.1.0 dict option extended to support ``gzip`` and ``bz2``. | ||
.. versionchanged:: 1.2.0 Previous versions forwarded dict entries for 'gzip' to ``gzip.open``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is the idea to do 1.2.0 separately?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was pushback when I suggested removing everything up to 1.4
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm good with going up to, but not including, 1.3. That seemed to be the consensus in #51071 to me (note @lithomas1 first said up to 1.1, then up to 1.3.5 after).
Looking at the last 30 days of downloads, 1.3.5 is at 18% whereas 1.2.5 is at 5%.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Will do as follow up.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @phofl
Thanks @phofl |
* DOC: Remove versionadded/changed for 1.1.0 * Update contributing_codebase.rst * Remove double line break * Fix
* DOC: Remove versionadded/changed for 1.1.0 * Update contributing_codebase.rst * Remove double line break * Fix
* DOC: Remove versionadded/changed for 1.1.0 * Update contributing_codebase.rst * Remove double line break * Fix
doc/source/whatsnew/vX.X.X.rst
file if fixing a bug or adding a new feature.removed 1.0 and earlier for 2.0, so can remove 1.1.0 for 2.1 I guess