gap-packages / recog

The GAP package recog to collect methods for constructive recognition
https://gap-packages.github.io/recog/
GNU General Public License v3.0
6 stars 14 forks source link

Make a list of functions that should be documented #129

Open ssiccha opened 5 years ago

ssiccha commented 5 years ago

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:

fingolfin commented 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/ ?

ssiccha commented 5 years ago

The list doesn't add much. In hindsight "Document everything that is in base/" would have been a lot shorter.