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

Add docs for new pip debug command #6672

Closed
cjerdonek opened this issue Jul 2, 2019 · 1 comment · Fixed by #6731
Closed

Add docs for new pip debug command #6672

cjerdonek opened this issue Jul 2, 2019 · 1 comment · Fixed by #6731
Labels
auto-locked Outdated issues that have been locked by automation type: docs Documentation related

Comments

@cjerdonek
Copy link
Member

This is a follow-up issue to PR #6638 to add docs for the new pip debug command. As @xavfernandez said in this comment:

It would also need basic documentation (at least a docs/html/reference/pip_debug.rst) and most importantly (IMHO), strongly emphasize that the output and the options of this command are provisional and might change without notice.

@triage-new-issues triage-new-issues bot added the S: needs triage Issues/PRs that need to be triaged label Jul 2, 2019
@cjerdonek cjerdonek added the type: docs Documentation related label Jul 2, 2019
@triage-new-issues triage-new-issues bot removed the S: needs triage Issues/PRs that need to be triaged label Jul 2, 2019
@pradyunsg
Copy link
Member

I think we should print a warning on every run of pip debug -- something along the lines of:

NOTE: This command is only meant for debugging. Do not use this with automation for parsing and getting these details, since the output and options of this command may change without notice.

@lock lock bot added the auto-locked Outdated issues that have been locked by automation label Aug 17, 2019
@lock lock bot locked as resolved and limited conversation to collaborators Aug 17, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
auto-locked Outdated issues that have been locked by automation type: docs Documentation related
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants