Skip to content
Prev Previous commit
Next Next commit
add note to whatsnew
  • Loading branch information
nsarang committed Aug 14, 2022
commit e2d21e371e270b2f632ac31f5233fff301f25c04
2 changes: 1 addition & 1 deletion doc/source/whatsnew/v1.4.4.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Fixed regressions
~~~~~~~~~~~~~~~~~
- Fixed regression in :func:`concat` materializing :class:`Index` during sorting even if :class:`Index` was already sorted (:issue:`47501`)
- Fixed regression in setting ``None`` or non-string value into a ``string``-dtype Series using a mask (:issue:`47628`)
-
- Fixed regression in :func:`merge` throwing an error when passing a :class:`Series` with a multi-level name
Copy link
Member

Choose a reason for hiding this comment

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

if there is no issue then the PR number should be added as the issue instead

(imo that should never happen though as an issue should always be raised to document the issue. there are many reasons to do this, help users find it, avoid duplicate issues, allow proper triage and give others an opportunity for discussion, and keep these out of the PR discussion as appears to have happen here)

Copy link
Member

Choose a reason for hiding this comment

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

and also sometimes PRs go stale so the discussion in those cases is effectively lost.

Copy link
Member

Choose a reason for hiding this comment

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

Good point, thanks for pointing out Simon!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree with the sentiment. The only reason that I didn't create an issue in the first place was that I thought the bug happened because of a typo and that this PR should be straightforward. Aside from this, I want to point out two things:

  1. Now that you've decided to reference the PR instead of the issue, you may want to add the base path of Github PRs to sphinx.ext.extlinks. From what I'm seeing, only the base path of issues is provided in the configuration file.
  2. FYI, I ran into this bug when I was applying a complex function to a Series after a multi-level GroupBy.
Copy link
Member

@jorisvandenbossche jorisvandenbossche Aug 22, 2022

Choose a reason for hiding this comment

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

  1. Now that you've decided to reference the PR instead of the issue, you may want to add the base path of Github PRs to sphinx.ext.extlinks. From what I'm seeing, only the base path of issues is provided in the configuration file.

GitHub itself handles those links fine. For example the link for this PR (#47946), also works (redirects) if used with "issues": #47946

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Uh I see. Thanks @jorisvandenbossche !


.. ---------------------------------------------------------------------------

Expand Down