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

Improve the installation instructions #1634

Merged
merged 4 commits into from Jul 22, 2020
Merged

Conversation

valeriupredoi
Copy link
Contributor

@valeriupredoi valeriupredoi commented Apr 27, 2020

Before you start, read CONTRIBUTING.md and the guide for diagnostic developers.

Please discuss your idea with the development team before getting started, to avoid disappointment later. The way to do this is to open a new issue on GitHub. If you are planning to modify an existing functionality, please discuss it with the original author(s) by tagging them in the issue.


Tasks

  • Create an issue to discuss what you are going to do, if you haven't done so already (and add the link at the bottom)
  • Give this pull request a descriptive title that can be used as a one line summary in a changelog
  • Circle/CI tests pass. Status can be seen below your pull request. If the tests are failing, click the link to find out why.
  • Preferably Codacy code quality checks pass, however a few remaining hard to solve Codacy issues are still acceptable. Status can be seen below your pull request. If there is an error, click the link to find out why. If you suspect Codacy may be wrong, please ask by commenting.

If you need help with any of the tasks above, please do not hesitate to ask by commenting in the issue or pull request.


Closes {Link to corresponding issue}

Copy link
Member

@bouweandela bouweandela left a comment

Looks good! Some minor comments about the last few lines.

doc/sphinx/source/quickstart/installation.rst Outdated Show resolved Hide resolved
doc/sphinx/source/quickstart/installation.rst Outdated Show resolved Hide resolved
doc/sphinx/source/quickstart/installation.rst Outdated Show resolved Hide resolved
@bouweandela bouweandela changed the title added some improvements to the install instructions Improve the installation instructions Apr 28, 2020
Copy link
Member

@bouweandela bouweandela left a comment

Thanks for the updates! The explanation of pip vs setup.py is still not quite correct though (and maybe not needed either).

doc/sphinx/source/quickstart/installation.rst Outdated Show resolved Hide resolved
@mattiarighi mattiarighi removed this from Review in High priority issues May 22, 2020
Removed note on the difference between 'pip install' and 'python setup.py' as it is deemed outside of the scope of the installation chapter.
Copy link
Member

@bouweandela bouweandela left a comment

@bouweandela bouweandela merged commit 19a4629 into master Jul 22, 2020
@bouweandela bouweandela deleted the improve_install_instructions branch Jul 22, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants