Skip to content

DOC: Update 1.0.1 release notes #31699

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 1 commit into from
Feb 5, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions doc/source/whatsnew/v1.0.1.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _whatsnew_101:

What's new in 1.0.1 (??)
------------------------
What's new in 1.0.1 (February 5, 2020)
--------------------------------------

These are the changes in pandas 1.0.1. See :ref:`release` for a full changelog
including other versions of pandas.
Expand Down Expand Up @@ -74,3 +74,5 @@ Bug fixes

Contributors
~~~~~~~~~~~~

.. contributors:: v0.25.3..v1.0.1|HEAD
Copy link
Member

Choose a reason for hiding this comment

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

this is nice!

Is it needed to remove once it is released? (because you say below "for development versions (before a tag is available)")

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's not needed after we tag. Assuming there aren't any bugs, we can leave it like this and it should just use the v1.0.1 tag after it's present.

Copy link
Member

Choose a reason for hiding this comment

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

Actually, this should have been v1.0.0..v1.0.1 instead of v0.25.3..v1.0.1 I suppose?

Also should this be "HEAD of 1.0.x branch" instead of "HEAD" ?

Copy link
Member

Choose a reason for hiding this comment

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

10 changes: 10 additions & 0 deletions doc/sphinxext/announce.py
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,16 @@ def get_authors(revision_range):
pat = "^.*\\t(.*)$"
lst_release, cur_release = [r.strip() for r in revision_range.split("..")]

if "|" in cur_release:
# e.g. v1.0.1|HEAD
maybe_tag, head = cur_release.split("|")
assert head == "HEAD"
if maybe_tag in this_repo.tags:
cur_release = maybe_tag
else:
cur_release = head
revision_range = f"{lst_release}..{cur_release}"

# authors, in current release and previous to current release.
cur = set(re.findall(pat, this_repo.git.shortlog("-s", revision_range), re.M))
pre = set(re.findall(pat, this_repo.git.shortlog("-s", lst_release), re.M))
Expand Down
8 changes: 7 additions & 1 deletion doc/sphinxext/contributors.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,13 @@

This will be replaced with a message indicating the number of
code contributors and commits, and then list each contributor
individually.
individually. For development versions (before a tag is available)
use::

.. contributors:: v0.23.0..v0.23.1|HEAD

While the v0.23.1 tag does not exist, that will use the HEAD of the
branch as the end of the revision range.
"""
from announce import build_components
from docutils import nodes
Expand Down