Skip to content

CLN/DOC: standardize wording on previous-removals #30488

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 2 commits into from
Dec 26, 2019

Conversation

jbrockmendel
Copy link
Member

In the 1.0.0 whatsnew we currently have 3 variants of "Removed :foo:X"

- Removed the previously deprecated :meth:`X`
- Removed previously deprecated :meth:`X`
- Removed :meth:`X`

I think we should standardize on one of these (lest readers think the difference is meaningful). I don't particularly care which, but for this PR went with the last one as it is the least verbose

- Removed the previously deprecated "labels" keyword from :meth:`MultiIndex.set_codes`, :meth:`MultiIndex.copy`, :meth:`MultiIndex.drop`, use "codes" instead (:issue:`23752`)
- Removed support for legacy HDF5 formats (:issue:`29787`)
- Passing a dtype alias (e.g. 'datetime64[ns, UTC]') to :class:`DatetimeTZDtype` is no longer allowed, use :meth:`DatetimeTZDtype.construct_from_string` instead (:issue:`23990`)
- :func:`read_excel` removed support for "skip_footer" argument, use "skipfooter" instead (:issue:`18836`)
- :func:`read_excel` no longer allows an integer value for the parameter ``usecols``, instead pass a list of integers from 0 to ``usecols`` inclusive (:issue:`23635`)
- :meth:`DataFrame.to_records` no longer supports the argument "convert_datetime64" (:issue:`18902`)
- Removed the previously deprecated ``IntervalIndex.from_intervals`` in favor of the :class:`IntervalIndex` constructor (:issue:`19263`)
Copy link
Member Author

Choose a reason for hiding this comment

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

note this also changes double-backticks to :meth:, unless there was a reason for this?

@jbrockmendel
Copy link
Member Author

The next step in this process would be to standardize wording for "removed keyword X from Y"

@jreback jreback added Deprecate Functionality to remove in pandas Docs labels Dec 26, 2019
@jreback jreback added this to the 1.0 milestone Dec 26, 2019
@jreback jreback merged commit 7b2eb54 into pandas-dev:master Dec 26, 2019
@jreback
Copy link
Contributor

jreback commented Dec 26, 2019

thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Deprecate Functionality to remove in pandas Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants