Use # optional - gap_package_grape etc. instead of # optional - gap_packages
#36025
Conversation
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
added 4 commits
August 2, 2023 12:53
…gap_package_grape
…d doctest tag gap_package_quagroup
… # optional - gap_packages
dcoudert
suggested changes
Aug 5, 2023
|
On 5 August 2023 12:35:41 BST, David Coudert ***@***.***> wrote:
@dcoudert requested changes on this pull request.
why do we have so many different packages for gap and how should one know which one to use ?
it is usually clear from GAP's LoadPackage calls in Sage code.
…
> @@ -182,13 +182,13 @@ def hap_decorator(f):
sage: from sage.groups.perm_gps.permgroup import hap_decorator
sage: def foo(self, n, p=0): print("Done")
sage: foo = hap_decorator(foo)
- sage: foo(None, 3) #optional - gap_packages
+ sage: foo(None, 3) #optional - gap_package_hap
`#optional` -> `# optional`, and we could use a block stop here
> Done
- sage: foo(None, 3, 4) #optional - gap_packages
+ sage: foo(None, 3, 4) #optional - gap_package_hap
`#optional` -> `# optional`
> @@ -1063,14 +1063,14 @@ def __init__(self, n):
EXAMPLES::
- sage: G = groups.permutation.Janko(1); G # optional - gap_packages internet
+ sage: G = groups.permutation.Janko(1); G # optional - gap_package_atlasrep internet
double space before `# optional`, many places
|
|
At least in some cases, also the docstrings contained information about which GAP package is needed. |
dcoudert
approved these changes
Aug 5, 2023
|
Thank you! |
SageMath version 10.1.beta9, Release Date: 2023-08-05
|
Documentation preview for this PR (built with commit babd64f; changes) is ready! 🎉 |
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Aug 11, 2023
sagemathgh-36025: Use `# optional - gap_package_grape` etc. instead of `# optional - gap_packages` <!-- ^^^^^ 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 --> <!-- Why is this change required? What problem does it solve? --> The Sage distribution has an optional SPKG `gap_packages`, which is a collection of GAP packages used by parts of Sage. The doctests that uses these packages are currently marked `# optional - gap_packages`. Here we switch to using more specific feature tags. These more specific features are tested dynamically, which works outside of the Sage distribution. <!-- 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: ... --> - Depends on sagemath#36017 <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36025 Reported by: Matthias Köppe Reviewer(s): David Coudert
vbraun
pushed a commit
to vbraun/sage
that referenced
this pull request
Aug 12, 2023
sagemathgh-36034: Fix block-scoped doctest tags with `\` line continuations <!-- ^^^^^ 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 --> <!-- Why is this change required? What problem does it solve? --> Fixes sagemath#36033 (comment) <!-- 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. - [ ] The description explains in detail what this PR is about. - [x] 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: ... --> - Depends on sagemath#36025 (merged here) <!-- If you're unsure about any of these, don't hesitate to ask. We're here to help! --> URL: sagemath#36034 Reported by: Matthias Köppe Reviewer(s): Kwankyu Lee, Matthias Köppe
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The Sage distribution has an optional SPKG
gap_packages, which is a collection of GAP packages used by parts of Sage.The doctests that uses these packages are currently marked
# optional - gap_packages. Here we switch to using more specific feature tags. These more specific features are tested dynamically, which works outside of the Sage distribution.📝 Checklist
⌛ Dependencies