[proxy] github.com← back | site home | direct (HTTPS) ↗ | proxy home | ◑ dark◐ light
/ cpython Public

Conversation

Copy link
Contributor

timofurrer commented May 31, 2018

This change addresses the issue here: https://bugs.python.org/issue33600

Is there a better marker than .. versionchanged:: for this? I tried to find similar situations, but couldn't find any. Maybe someone could point me to one?

https://bugs.python.org/issue33600

timofurrer changed the title bpo-33600: document that platform.linux_distribution() has been removed [2.7] bpo-33600: document that platform.linux_distribution() has been removed May 31, 2018
Copy link
Member

Choose a reason for hiding this comment

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

I don't think that it's correct to use ".. versionchanged:: 3.8" tag in Python 2.7. Just add a regular paragraph before ".. versionadded:: 2.6".

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Copy link
Member

Choose a reason for hiding this comment

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

please add "Python": since Python 3.5 ... removed in Python 3.8

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done

Copy link

A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated.

Once you have made the requested changes, please leave a comment on this pull request containing the phrase I have made the requested changes; please review again. I will then notify any core developers who have left a review that you're ready for them to take another look at this pull request.

And if you don't make the requested changes, you will be poked with soft cushions!

Copy link
Contributor Author

I have made the requested changes; please review again

Copy link

Thanks for making the requested changes!

@vstinner: please review the changes made to this pull request.

Copy link
Member

vstinner left a comment

Choose a reason for hiding this comment

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

LGTM, but I would prefer to have a second review from a second core developer, but I'm not 100% sure that we should document this Python 3 change in the Python 2.7 doc.

Copy link
Member

encukou commented Jun 5, 2018

This has some precedent in e.g. urllib docs.
Perhaps use a Note like in urllib? But this way it looks fine too, to me at least.

Copy link
Member

vstinner commented Jun 5, 2018

Perhaps use a Note like in urllib?

I looked at the HTML output. Honestly, if you don't read carefully the whole documentation, you can easily miss the new note.

I modified the doc to use a ".. note::" and I agree that it's much easier to catch this note. So yes, please, @timofurrer: modify your PR to write the new paragraph as a note.

   Returns a tuple ``(distname,version,id)`` which defaults to the args given as
   parameters.  ``id`` is the item in parentheses after the version number.  It
   is usually the version codename.

   .. note::
      This function is deprecated since Python 3.5 and removed in Python 3.8.
      See alternative like the `distro <https://pypi.org/project/distro>`_
      package.

   .. versionadded:: 2.6

timofurrer force-pushed the bugfix/issue-33600 branch from 2550180 to f78323c Compare June 5, 2018 19:43
Copy link
Contributor Author

timofurrer commented Jun 5, 2018

@vstinner done!

vstinner merged commit 7b9b87e into python:2.7 Jun 5, 2018
Copy link
Member

vstinner commented Jun 5, 2018

@timofurrer: Thank you Timo Furrer for your contribution! It's better as the note ;-)

Thanks @encukou for the review as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants