Skip to content

Update mkvirtualenv help to document -p/--python option #109

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

Merged

Conversation

claudia-blanc
Copy link

This pull request updates the virtualenvwrapper_mkvirtualenv_help function to include documentation for the -p and --python options when creating a new virtual environment with mkvirtualenv. It documents functionality that already exists in the script but was not previously mentioned in the help text.

Changes made:

  • Added explanation of the -p and --python options in the help output
  • Provided examples of how to use these options

Copy link
Contributor

@carltongibson carltongibson left a comment

Choose a reason for hiding this comment

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

Looks good. 👍 (I use this all the time. Good idea to mention it I think)

Copy link
Contributor

@dhellmann dhellmann left a comment

Choose a reason for hiding this comment

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

Nice, thank you!

@mergify mergify bot added the documentation Improvements or additions to documentation label Oct 13, 2024
@claudia-blanc
Copy link
Author

During the check, the style (docs) and the docs tests failed because of this error (from the corresponding logs):
( install: line 57) broken https://sourceforge.net/projects/mingw/files/MSYS/ - 403 Client Error: Forbidden for url: https://sourceforge.net/projects/mingw/files/MSYS/

Options proposed to fix the problem in the docs > source > install.rst file:

  1. Adding a different link for the MSYS mktemp binary:
  1. Adding the link to the GNU Win32 mktemp binary:
  1. Deleting the link.

Option 1 applied.

@dhellmann
Copy link
Contributor

Ah, sorry, I didn't see the notification for the update to this PR and I made and merged a conflicting change. Let me see if I can resolve that.

@dhellmann
Copy link
Contributor

@Mergifyio rebase

Copy link
Contributor

mergify bot commented Oct 13, 2024

rebase

❌ Base branch update has failed

Git reported the following error:

Rebasing (1/3)
Rebasing (2/3)
Rebasing (3/3)
Auto-merging docs/source/install.rst
CONFLICT (content): Merge conflict in docs/source/install.rst
error: could not apply fcf5df2... Update broken MSYS link in installation documentation
hint: Resolve all conflicts manually, mark them as resolved with
hint: "git add/rm <conflicted_files>", then run "git rebase --continue".
hint: You can instead skip this commit: run "git rebase --skip".
hint: To abort and get back to the state before "git rebase", run "git rebase --abort".
Could not apply fcf5df2... Update broken MSYS link in installation documentation

@dhellmann
Copy link
Contributor

@Mergifyio rebase

Copy link
Contributor

mergify bot commented Oct 13, 2024

rebase

✅ Branch has been successfully rebased

@dhellmann dhellmann force-pushed the update-mkvirtualenv-help branch from 7cce3f1 to 6d2f603 Compare October 13, 2024 21:32
@mergify mergify bot merged commit 008383a into python-virtualenvwrapper:main Oct 13, 2024
17 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants