Improve documentation of various gap-related methods #39905
Merged
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
user202729
force-pushed
the
gap-improve-doc
branch
from
f32e829 to
fbc3629
Compare
user202729
force-pushed
the
gap-improve-doc
branch
from
fbc3629 to
f29bd6d
Compare
This was referenced Apr 8, 2025
|
Documentation preview for this PR (built with commit 4b238ad; changes) is ready! 🎉 |
user202729
commented
May 24, 2025
| Return a Gap object. | ||
| Unlike :meth:`_libgap_`, this method returns an instance of | ||
| :class:`sage.interfaces.gap.GapElement`, which wraps an object |
Contributor
Author
There was a problem hiding this comment.
I'm not quite sure if this is the intention, or maybe this can return an instance of sage.libs.gap.libgap.GapElement if the argument G is libgap — with careful implementation, the method can be made to work in both cases.
Not sure what's the advantage of doing that however. If I recalled correctly some other parts of the code also did that.
Contributor
|
looks good to me. I will wait for the CI |
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.
As in the title.
There will be no visible change to the user because these methods all start with
_, only to Sage developers.The reason is… there's a lot of confusion in downstream implementations, so it looks like whoever initially wrote that code wasn't aware of the convention. See #39908 .
📝 Checklist
⌛ Dependencies