Open ssiccha opened 5 years ago
While I don't mind this issue / list, I also don't quite see the point. What does it add over "go through the code and document things, and make sure to in particular document everything in base/
?
The list doesn't add much. In hindsight "Document everything that is in base/
" would have been a lot shorter.
We should figure out for which currently undocumented functions it would be beneficial to have documentation in the manual. I have the impression that at least all functions in
base/
should be documented.Note that when documenting these functions this is also the perfect time to think about new, more appropriate names as in PR #128.
Feel free to add more functions to the following list of all currently undocumented functions in
base/*.gd
files:base/projective.gd
IsOneProjective
IsEqualProjective
base/recognition.gd
IsRecogInfoForSimpleGroup
IsRecogInfoForAlmostSimpleGroup
slptostd
EmptyRecognitionInfoRecord
PrintTreePos
RandomSubproduct
FastNormalClosure
RandomElm
RandomElmOrd
RandomElmPpd
RandomOrdersSeen
StopStoringRandEls
GetElmOrd
GetElmPpd
GetCompositionTreeNode
VerifyPermGroup
VerifyMatrixGroup
VerifyProjectiveGroup
VerifyGroup