Skip to content
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.

Sign up for GitHub

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

Jump to bottom

add example for deprecated-module message documentation #6139

Closed
wants to merge 12 commits into from
Closed

add example for deprecated-module message documentation #6139

wants to merge 12 commits into from

Conversation

gunungpw
Copy link
Contributor

@gunungpw gunungpw commented Apr 2, 2022 •
edited
Loading

  • Write a good description on what the PR does.

Type of Changes

Type
✓ 📜 Docs

Description

  • add example code for deprecated-module
  • add link for PEP 594 and Official Python Changelog

Ref #5953

Pierre-Sassoulas
Pierre-Sassoulas reviewed Apr 2, 2022
View reviewed changes
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

setuptools and argparse are what somewhat replaced distutils and optparse.

doc/data/messages/d/deprecated-module/good.py Outdated Show resolved Hide resolved
@Pierre-Sassoulas Pierre-Sassoulas added this to the 2.14.0 milestone Apr 2, 2022
@Pierre-Sassoulas Pierre-Sassoulas mentioned this pull request Apr 2, 2022
Closed
4 tasks
gunungpw and others added 6 commits April 2, 2022 21:31
@gunungpw @Pierre-Sassoulas
Update doc/data/messages/d/deprecated-module/good.py
95e17cf 
replace imported module with more relevant example

Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
784f20f 
for more information, see https://pre-commit.ci
@gunungpw
Update related.rst
c78f5aa 
add PEP Title
@gunungpw
Update good.py
b667e96 
remove newline
@gunungpw
Update good.py
5e7fb8b 
fix again
@pre-commit-ci
[pre-commit.ci] auto fixes from pre-commit.com hooks
515ff61 
for more information, see https://pre-commit.ci
Pierre-Sassoulas
Pierre-Sassoulas approved these changes Apr 2, 2022
View reviewed changes
Copy link
Member

@Pierre-Sassoulas Pierre-Sassoulas left a comment

Choose a reason for hiding this comment

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

We're not raising deprecate message for setuptools whatever the py-version, and one example is enough.

doc/data/messages/d/deprecated-module/bad.py Outdated Show resolved Hide resolved
doc/data/messages/d/deprecated-module/good.py Outdated Show resolved Hide resolved
@DanielNoord
Copy link
Collaborator

@gunungpw A heads-up: we now enforce the use of - as the list indicator in related.rst. This was the most common and we wanted to unify the character. Some of your current PRs might need updating. Sorry about that!

@Pierre-Sassoulas Pierre-Sassoulas removed this from the 2.14.0 milestone May 17, 2022
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DanielNoord DanielNoord DanielNoord approved these changes

@Pierre-Sassoulas Pierre-Sassoulas Pierre-Sassoulas approved these changes

Assignees
No one assigned
Labels
Documentation 📗
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@gunungpw @DanielNoord @Pierre-Sassoulas