Clarify doc of init in map_word
#4498
Merged
Conversation
This file contains 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
lgoettgens
added
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #4498 +/- ##
==========================================
- Coverage 84.55% 84.55% -0.01%
==========================================
Files 672 672
Lines 88888 88833 -55
==========================================
- Hits 75158 75109 -49
+ Misses 13730 13724 -6
|
ThomasBreuer
approved these changes
Jan 24, 2025
src/Groups/GAPGroups.jl
Outdated
|
|
||
| If `init` is different from `nothing`, return $x g_{i_1}^{e_1} g_{i_2}^{e_2} \cdots g_{i_n}^{e_n}$ where $x =$ `init`. | ||
|
|
||
| See also: [`map_word(::Union{FPGroupElem, SubFPGroupElem}, ::Vector)`](@ref), [`map_word(::Vector{Union{Int, Pair{Int, Int}}}, ::Vector)`](@ref). |
There was a problem hiding this comment.
The two references point to the same section. Wouldn't one reference be enough?
There was a problem hiding this comment.
Right. I removed the second one.
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 behaviour of
inithas been settled in #3892, but there were some problems with the documentation:initwas not documented at all forPcGroups.map_word([], genimgs, init=init)isone(genimgs[1])ifgenimgsis non-empty. This is incorrect, it isinit.initis the left-most factor if it is specified to the beginning. I found the way it was done previously confusing.I also added examples illustrating the behaviour for integer lists and for
map_word([], []).