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 canned explanation about feature preview flag to deprecated(). #10167

Merged
merged 1 commit into from
Jul 28, 2021
Merged

Add canned explanation about feature preview flag to deprecated(). #10167

merged 1 commit into from
Jul 28, 2021

Conversation

maresb
Copy link
Contributor

@maresb maresb commented Jul 17, 2021

Closes #10165

uranusjr
uranusjr requested changes Jul 18, 2021
View reviewed changes
news/10165.feature.rst Outdated Show resolved Hide resolved
src/pip/_internal/utils/deprecation.py Outdated Show resolved Hide resolved
src/pip/_internal/utils/deprecation.py Outdated Show resolved Hide resolved
src/pip/_internal/utils/deprecation.py Outdated Show resolved Hide resolved
src/pip/_internal/utils/deprecation.py Outdated Show resolved Hide resolved
@maresb
Copy link
Contributor Author

maresb commented Jul 19, 2021

Thanks @uranusjr so much for the review! I really appreciate it. I'm on the road at the moment but I will try to address everything soon.

@maresb
Copy link
Contributor Author

maresb commented Jul 20, 2021

Hello @uranusjr, I have attempted to address all of the points you raised. I am ready for the next round of review. I'm happy to further elaborate on my motivation, or to rebase/squash my commits. Thank you!

@pradyunsg
Copy link
Member

I am a -1 on this PR as it stands -- more context at #10165 (comment).

This was referenced Jul 23, 2021
Merged
Closed
@pypa-bot
Copy link

Hello!

I am an automated bot and I have noticed that this pull request is not currently able to be merged. If you are able to either merge the master branch into this pull request or rebase this pull request against master then it will eligible for code review and hopefully merging!

@pypa-bot pypa-bot added the needs rebase or merge PR has conflicts with current master label Jul 27, 2021
@maresb maresb force-pushed the gone-in-message branch from b16e379 to e898b1e Compare July 27, 2021 21:08
@pypa-bot pypa-bot removed the needs rebase or merge PR has conflicts with current master label Jul 27, 2021
@maresb maresb changed the title Allow adjustment of deprecation gone_in message Add canned explanation about feature preview flag to deprecated(). Jul 27, 2021
@maresb
Copy link
Contributor Author

maresb commented Jul 27, 2021

Closes #10223

@maresb
Copy link
Contributor Author

maresb commented Jul 27, 2021

@pradyunsg and @uranusjr, do the latest commits satisfactorily address all your concerns?

uranusjr
uranusjr reviewed Jul 28, 2021
View reviewed changes
Copy link
Member

@uranusjr uranusjr left a comment

Choose a reason for hiding this comment

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

One minor thought, generally looks good enough to me.

src/pip/_internal/utils/deprecation.py Show resolved Hide resolved
@maresb maresb mentioned this pull request Jul 28, 2021
Closed
1 task
@maresb
Copy link
Contributor Author

maresb commented Jul 28, 2021

Oops, I need to adjust the unit tests now...

maresb added a commit to maresb/pip that referenced this pull request Jul 28, 2021
@maresb
Update unit test for pypa#10167
682ea04
@maresb maresb force-pushed the gone-in-message branch from 682ea04 to dbf994e Compare July 28, 2021 07:26
@maresb
Copy link
Contributor Author

maresb commented Jul 28, 2021

@uranusjr and @pradyunsg, unit tests are passing, and from my side things look ready to go. Thus I squashed my commits to tidy things up. Any final comments?

uranusjr
uranusjr approved these changes Jul 28, 2021
View reviewed changes
Copy link
Member

@uranusjr uranusjr left a comment

Choose a reason for hiding this comment

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

The repeated formatted_xxx = XXX.format() if foo else None feels cumbersome, but it does the job, and functionality-wise lgtm.

@pradyunsg pradyunsg merged commit 82cfebe into pypa:main Jul 28, 2021
@pradyunsg
Copy link
Member

Thanks @maresb! I quite like where we ended up here, functionality wise! ^>^

@pradyunsg pradyunsg mentioned this pull request Jul 28, 2021
Merged
@maresb maresb deleted the gone-in-message branch July 29, 2021 06:22
@maresb
Copy link
Contributor Author

maresb commented Jul 29, 2021

Great, thanks so much for the merge @pradyunsg! I agree that this ended well, I like the current solution much better than my original proposal, so thank you and @uranusjr for the collaboration.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 27, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@uranusjr uranusjr uranusjr approved these changes

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

Successfully merging this pull request may close these issues.

Allow customized gone_in sentence for deprecation messages
4 participants
@maresb @pradyunsg @pypa-bot @uranusjr