Skip to content

Whatsnew1.3.0 links #41795

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 6 commits into from
Jun 4, 2021
Merged

Conversation

rhshadrach
Copy link
Member

  • Ensure all linting tests pass, see here for how to run them

Part of #41747

@rhshadrach rhshadrach added the Docs label Jun 3, 2021
@rhshadrach rhshadrach added this to the 1.3 milestone Jun 3, 2021
Copy link
Member

@simonjayhawkins simonjayhawkins left a comment

Choose a reason for hiding this comment

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

Thanks @rhshadrach

some other broken links:

Styler.to_html on L145 is broken.
MultiIndex.set_names and MultiIndex.rename
Window
Series.getitem() and DataFrame.getitem()
Styler.hidden_index and Styler.hidden_columns
Styler
Series.loc.getitem() and Series.loc.setitem()
FloatingArray
Rolling, Expanding, and ExponentialMovingWindow
Categorical.unique()
GroupBy.rolling()
astype()
MultiIndex.is_lexsorted() and MultiIndex.lexsort_depth(), use MultiIndex.is_monotonic_increasing()
Rolling.win_type
Rolling.is_datetimelike
ExponentialMovingWindow.vol()
DatetimeIndex.union()
Categorical._codes
MultiIndex.drop_duplicates

and many others. not sure is all can be fixed. maybe rewording is required in some cases.

- :meth:`round` being enabled for the nullable integer and floating dtypes (:issue:`38844`)
- :meth:`pandas.read_csv` and :meth:`pandas.read_json` expose the argument ``encoding_errors`` to control how encoding errors are handled (:issue:`39450`)
- :meth:`Series.round` and :meth:`DataFrame.round` now work with nullable integer and floating dtypes (:issue:`38844`)
- :meth:`read_csv` and :meth:`read_json` expose the argument ``encoding_errors`` to control how encoding errors are handled (:issue:`39450`)
Copy link
Member

Choose a reason for hiding this comment

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

should these be func too for consistency?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep - thanks (though I don't think it changes the resulting page, certainly +1 on consistency here)

Copy link
Member

Choose a reason for hiding this comment

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

yes. :meth: and :func: seem interchangeable. not sure why we have both.

@@ -247,7 +247,7 @@ These are bug fixes that might have notable behavior changes.
``Categorical.unique`` now always maintains same dtype as original
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Previously, when calling :meth:`~Categorical.unique` with categorical data, unused categories in the new array
Previously, when calling :meth:`Categorical.unique` with categorical data, unused categories in the new array
Copy link
Member

Choose a reason for hiding this comment

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

this link broken anyway

Copy link
Member Author

Choose a reason for hiding this comment

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

Right, but the difference is that :meth:`~Categorical.unique just shows "unique" whereas the change has it show up as "Categorical.unique". I think the latter is preferred.

Copy link
Member

Choose a reason for hiding this comment

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

didn't mean for this to be changed. feel free to change this again. but was thinking that could maybe reword instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

Doh! I changed it just to make sure my understanding of the behavior was correct, but forgot to change it back. The fix is now in #41822

@@ -659,29 +659,29 @@ Deprecations
- Deprecated allowing scalars to be passed to the :class:`Categorical` constructor (:issue:`38433`)
- Deprecated constructing :class:`CategoricalIndex` without passing list-like data (:issue:`38944`)
- Deprecated allowing subclass-specific keyword arguments in the :class:`Index` constructor, use the specific subclass directly instead (:issue:`14093`, :issue:`21311`, :issue:`22315`, :issue:`26974`)
- Deprecated ``astype`` of datetimelike (``timedelta64[ns]``, ``datetime64[ns]``, ``Datetime64TZDtype``, ``PeriodDtype``) to integer dtypes, use ``values.view(...)`` instead (:issue:`38544`)
- Deprecated :meth:`astype` of datetimelike (``timedelta64[ns]``, ``datetime64[ns]``, ``Datetime64TZDtype``, ``PeriodDtype``) to integer dtypes, use ``values.view(...)`` instead (:issue:`38544`)
Copy link
Member

Choose a reason for hiding this comment

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

astype broken link

Copy link
Member Author

Choose a reason for hiding this comment

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

Agreed - but no clear way to me to fix. Any suggestion?

@simonjayhawkins
Copy link
Member

some other broken links:

another pass will be fine, don't need to add to this PR. if you can merge master to resolve conflicts

@@ -277,10 +277,10 @@ As an example of this, given:
unique
original.dtype == unique.dtype

Preserve dtypes in :meth:`~pandas.DataFrame.combine_first`
Preserve dtypes in :meth:`DataFrame.combine_first`
Copy link
Contributor

Choose a reason for hiding this comment

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

doesn't this warn (line lenght)?

Copy link
Member Author

Choose a reason for hiding this comment

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

Thanks for catching this - I rebuilt the docs locally and got no warnings. CI is showing the same - not sure why that is.

Copy link
Member Author

Choose a reason for hiding this comment

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

From reST docs (https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections):

An underline/overline is a single repeated punctuation character that begins in column 1 and forms a line extending at least as far as the right edge of the title text. Specifically, an underline/overline character may be any non-alphanumeric printable 7-bit ASCII character 5. When an overline is used, the length and character used must match the underline.

Copy link
Member

@simonjayhawkins simonjayhawkins Jun 4, 2021

Choose a reason for hiding this comment

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

I think, we had some cases where I forgot to reduce the underline when changing release dates in a previous whatsnew at some point. IIRC didn't seem to do any harm, and rendered fine.

…atsnew1.3.0_links

� Conflicts:
�	doc/source/whatsnew/v1.3.0.rst
@rhshadrach
Copy link
Member Author

some other broken links:
...
and many others. not sure is all can be fixed. maybe rewording is required in some cases.

Thanks @simonjayhawkins - I've gone through your list and fixed the Styler and Styler.to_html.

For classes where we'd like to link to but don't have docs (e.g. attributes of a MultiIndex), we could certainly reword. For example:

  • Add support for dict-like names in :meth:MultiIndex.set_names and :meth:MultiIndex.rename (:issue:20421)

This could be reworded as

  • Add support for dict-like names in :meth:Index.set_names and :meth:Index.rename in the case of a :class:Multiindex (:issue:20421)

My opinion is that it'd be better to have docs for MultiIndex.set_names rather than change the phrasing of the whatsnew (but perhaps that poses its own challenges?). Even if consensus is to change the wording instead, I'd still like to consider such modifications out of scope for this PR.

For dunder methods, when there is a clear fix I plan to make them in a subsequent PR, however many cases it isn't clear to me how the docs should be changed.

@simonjayhawkins
Copy link
Member

Thanks @rhshadrach for the updates.

merging as is, so that can continue with #41747 and since merge conflicts are likely to quickly arise with this .

comments here can be addressed in another pass.

@simonjayhawkins simonjayhawkins merged commit 1131f8f into pandas-dev:master Jun 4, 2021
@rhshadrach rhshadrach deleted the whatsnew1.3.0_links branch June 23, 2021 01:00
JulianWgs pushed a commit to JulianWgs/pandas that referenced this pull request Jul 3, 2021
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.

3 participants