Skip to content

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

Merged
merged 4 commits into from
Apr 26, 2023

Conversation

phofl
Copy link
Member

@phofl phofl commented Apr 24, 2023

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest 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

@phofl phofl added the Docs label Apr 24, 2023
@@ -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
Copy link
Member

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)

Copy link
Member

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)

Copy link
Member Author

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

Copy link
Member

@MarcoGorelli MarcoGorelli left a 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
Copy link
Member

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``.
Copy link
Member

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?

Copy link
Member Author

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

Copy link
Member

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%.

Copy link
Member Author

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.

@MarcoGorelli MarcoGorelli added this to the 2.1 milestone Apr 25, 2023
Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @phofl

@mroeschke mroeschke merged commit b877b43 into pandas-dev:main Apr 26, 2023
@mroeschke
Copy link
Member

Thanks @phofl

@phofl phofl deleted the doc_remove_110 branch April 26, 2023 15:52
topper-123 pushed a commit to topper-123/pandas that referenced this pull request Apr 27, 2023
* DOC: Remove versionadded/changed for 1.1.0

* Update contributing_codebase.rst

* Remove double line break

* Fix
Rylie-W pushed a commit to Rylie-W/pandas that referenced this pull request May 19, 2023
* DOC: Remove versionadded/changed for 1.1.0

* Update contributing_codebase.rst

* Remove double line break

* Fix
Daquisu pushed a commit to Daquisu/pandas that referenced this pull request Jul 8, 2023
* DOC: Remove versionadded/changed for 1.1.0

* Update contributing_codebase.rst

* Remove double line break

* Fix
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants