Oscar.jl
Oscar.jl copied to clipboard
Missing docstrings for `permutation_group`, `pc_group`, `fp_group`
Some time ago @joschmitt (IIRC) improved things by adding methods for permutation_group
, pc_group
, fp_group
that take a group and return an isomorphic group but which is a permutation/pc/fp group -- before we did (and still do) the same with the types, i.e. PermGroup(G)
does the same as permutation_group(G)
.
However, these seem to be no docstrings for either of these conversions (i.e. either using the snake_case
function or the CamelCase
type names).
These should be added, and also reference isomorphism
("if you also need the isomorphism, please use isomorphism
" or so)
This is documented: https://github.com/oscar-system/Oscar.jl/blob/5b325bd343faabc9659f4a5d47c1d0ea094e7253/src/Groups/homomorphisms.jl#L746 There is just no chance to find it because the doc string is attached to a very weird signature as far as I can see.