README.md: Improve PyPI install instructions#37261
Merged
vbraun merged 2 commits intosagemath:developfrom Feb 29, 2024
Merged
Conversation
Contributor
|
Removing blocker as there are problems with other PRs, see #37428 for more details. |
Contributor
Author
|
Restoring "blocker" -- this PR needs to go into the stable release. |
Member
|
shouldn''t really be a blocker, oh well pet PR strikes again |
Contributor
Author
|
Thanks for the review. In a typical project, I'd say that fixing installation instructions ahead of a release would be considered normal maintainer activity. |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 25, 2024
sagemathgh-37261: `README.md`: Improve PyPI install instructions <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> Based on https://groups.google.com/g/sage-devel/c/1viBzw- ZaoQ/m/ZBbjHXGEAAAJ, we improve the section on installation from PyPI. We also improve **sage_conf** so that `python3 -m sage_conf` is equivalent to `sage-config`. After the next stable release is out, we can use this to simplify these installation instructions. Blocker because we need this to go in the 10.3 stable release. <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#37261 Reported by: Matthias Köppe Reviewer(s):
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Feb 26, 2024
sagemathgh-37261: `README.md`: Improve PyPI install instructions <!-- ^^^^^ Please provide a concise, informative and self-explanatory title. Don't put issue numbers in there, do this in the PR body below. For example, instead of "Fixes sagemath#1234" use "Introduce new method to calculate 1+1" --> <!-- Describe your changes here in detail --> Based on https://groups.google.com/g/sage-devel/c/1viBzw- ZaoQ/m/ZBbjHXGEAAAJ, we improve the section on installation from PyPI. We also improve **sage_conf** so that `python3 -m sage_conf` is equivalent to `sage-config`. After the next stable release is out, we can use this to simplify these installation instructions. Blocker because we need this to go in the 10.3 stable release. <!-- Why is this change required? What problem does it solve? --> <!-- If this PR resolves an open issue, please link to it here. For example "Fixes sagemath#12345". --> <!-- If your change requires a documentation PR, please link it appropriately. --> ### 📝 Checklist <!-- Put an `x` in all the boxes that apply. --> <!-- If your change requires a documentation PR, please link it appropriately --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> <!-- Feel free to remove irrelevant items. --> - [x] The title is concise, informative, and self-explanatory. - [x] The description explains in detail what this PR is about. - [ ] I have linked a relevant issue or discussion. - [ ] I have created tests covering the changes. - [ ] I have updated the documentation accordingly. ### ⌛ Dependencies <!-- List all open PRs that this PR logically depends on - sagemath#12345: short description why this is a dependency - sagemath#34567: ... --> <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#37261 Reported by: Matthias Köppe Reviewer(s):
|
Documentation preview for this PR (built with commit 41ad0b5; changes) is ready! 🎉 |
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
3 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.
Based on https://groups.google.com/g/sage-devel/c/1viBzw-ZaoQ/m/ZBbjHXGEAAAJ, we improve the section on installation from PyPI.
We also improve sage_conf so that
python3 -m sage_confis equivalent tosage-config.After the next stable release is out, we can use this to simplify these installation instructions.
Blocker because we need this to go in the 10.3 stable release.
📝 Checklist
⌛ Dependencies