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

Documentation Improvements for Windows + PowerShell #476

Open
2 tasks done
JosephSemrai opened this issue Dec 28, 2019 · 0 comments
Open
2 tasks done

Documentation Improvements for Windows + PowerShell #476

JosephSemrai opened this issue Dec 28, 2019 · 0 comments

Comments

@JosephSemrai
Copy link
Contributor

JosephSemrai commented Dec 28, 2019

Prerequisites

  • I am running the latest version
  • I checked to make sure that this issue has not already been filed

Expected Behavior

  1. By default, whether using Anaconda or some other installation of Python, virtualenv should be started with a reference to python rather than python3. An update to the documentation or a separate section containing this improvement + the one below opens the project to easier contribution.
  2. The starting documentation should provide different instructions (open the ps1 script, not bat) if the user is using PowerShell for clarity with regard to setting up virtualenv.
    For example, under the current documentation, the file referenced will not work at all using PowerShell or the Visual Studio Code Integrated Terminal. A reference or note mentioning this would ease the cloning of the project dramatically while also presenting a standardized setup process for those using PowerShell.
    image

Current Behavior

The documentation does not highlight this behavior and targets the following file:
image

Given permission, I'd like to open a pull request addressing this in the documentation.

@JosephSemrai JosephSemrai changed the title PowerShell documentation Documentation Improvements for Windows + PowerShell Dec 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant