Tiny suggestion for optional edit to instructions for editable installations#13
Merged
NoureldinYosri merged 2 commits intoquantumlib:mainfrom Nov 5, 2024
Merged
Conversation
In the section Installation, it gives an example of doing a local editable installation, and in the section Development and Testing, it gives an example of installing the package for development situations. Although it's true that the instructions as given will work after a fashion, the approach of using `pip install -e` is both more common for editable installs, and also arguably leads to more intuitive behavior when developing Python packages.
| --- | ||
|
|
||
| **Note:** This is not an officially supported Google product No newline at end of file | ||
| **Note:** This is not an officially supported Google product |
Collaborator
There was a problem hiding this comment.
what is happening to this line?
Contributor
Author
There was a problem hiding this comment.
It looks like it's just a difference in line endings. No content change.
Based on my local copy of the file, it looks like the original did not have a carriage return at the end of the line.
NoureldinYosri
approved these changes
Nov 5, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In the section Installation, it gives an example of doing a local editable installation, and in the section Development and Testing, it gives an example of installing the package for development situations. Although it's true that the instructions as given will work after a fashion, the approach of using
pip install -eis both more common for editable installs, and also arguably leads to more intuitive behavior when developing Python packages.This suggested change is optional; no offense taken if you decide not to apply it.