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.

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

Remove 'pip search' command #10431

Closed
wants to merge 5 commits into from
Closed

Remove 'pip search' command #10431

wants to merge 5 commits into from

Conversation

hugovk
Copy link
Contributor

@hugovk hugovk commented Sep 4, 2021

Fixes #5216.

news/5216.removal.rst Outdated Show resolved Hide resolved
docs/html/user_guide.rst Outdated Show resolved Hide resolved
:maxdepth: 1
:caption: Package Index information

pip_search
Copy link
Member

@uranusjr uranusjr Sep 4, 2021

Choose a reason for hiding this comment

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

I wonder if this would trigger the orphan page warning. (Not sure how to avoid it if so.) Is the cli/pip_search page currently mentioned anywhere in the documentation?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it triggers an orphan warning. It can be silenced by adding :orphan: at the top of the page.

It's only referenced in main at:

And the redirect at:

Should :orhpan: be added? Or the pages removed completely?


Relatedly, looks like a tox -e docs job is missing from the CI, there's another warning that has slipped through:

Warning, treated as error:
/Users/hugo/github/pip/docs/html/user_guide.rst:1011:undefined label: dependency resolution backtracking

Copy link
Member

@uranusjr uranusjr Sep 5, 2021

Choose a reason for hiding this comment

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

@pradyunsg Could we add a redirect to pip index?

I feel we can remove the page altogether and put a banner on top of the pip index page to tell users pip search has been removed and this is its replacement.

Copy link
Member

Choose a reason for hiding this comment

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

From my point of view, adding :orphan: should be ok for the pip search docs failure. Not sure if we should remove the page by now, I would personally prefer a removal a few releases after. A redirection to pip index sounds a good idea to me.

Anyone else has thoughts about this?

Copy link
Member

Choose a reason for hiding this comment

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

Any update on this?

@pradyunsg
Copy link
Member

Rebasing should fix the docs failure.

@github-actions github-actions bot added the needs rebase or merge PR has conflicts with current master label Sep 4, 2021
@pypa-bot pypa-bot removed the needs rebase or merge PR has conflicts with current master label Sep 4, 2021
@hugovk

This comment has been minimized.

docs/man/commands/index.rst Outdated Show resolved Hide resolved
Copy link
Member

@DiddiLeija DiddiLeija left a comment

Choose a reason for hiding this comment

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

@hugovk Can you please rebase (or recreate, maybe) this PR?

@hugovk
Copy link
Contributor Author

hugovk commented Mar 9, 2022

@DiddiLeija Rebased! And please see #10431 (comment), awaiting a decision how to proceed to fix the docs.

@DiddiLeija
Copy link
Member

Sure, I'm aware of that.

@github-actions github-actions bot added the needs rebase or merge PR has conflicts with current master label Mar 11, 2022
@pypa-bot pypa-bot removed the needs rebase or merge PR has conflicts with current master label Mar 17, 2022
@hugovk
Copy link
Contributor Author

hugovk commented Feb 11, 2023

Closing, re: #5216 (comment)

@hugovk hugovk closed this Feb 11, 2023
@pradyunsg
Copy link
Member

Thanks for filing this PR @hugovk! Much appreciated!

@hugovk
Copy link
Contributor Author

hugovk commented Feb 11, 2023

You're very welcome!

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 27, 2023
@hugovk hugovk deleted the rm-search branch October 13, 2024 09:59
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove the pip search command
6 participants