Improve doc of gap/matrix/slconstr.gi

[ssiccha]

• add a header comment which of these functions is actually used
• document SLCR.FindHom
• reference SLCR.FindHom in the documentation of
  FindHomMethodsMatrix.NaturalSL

TODO: the documentation of SLCR.FindHom does not appear in the manual.
@fingolfin, could you point me to the file I need to change? I had a look but didn't find anything.

[ssiccha]

@danielrademacher Maybe this is also interesting for you.

[ssiccha]

Also, FindHom should be renamed. While we're at it, what would be a good naming convention for leaf methods so that they can be easily grepped for? Maybe that's a topic for our next call.

[codecov]

Codecov Report

Merging #252 (f49b3ff) into master (f4cf7d3) will not change coverage.
The diff coverage is n/a.

❗ Current head f49b3ff differs from pull request most recent head 208e0e5. Consider uploading reports for the commit 208e0e5 to get more accurate results

@@           Coverage Diff           @@
##           master     #252   +/-   ##
=======================================
  Coverage   77.76%   77.76%           
=======================================
  Files          37       37           
  Lines       17497    17497           
=======================================
  Hits        13606    13606           
  Misses       3891     3891           

Impacted Files	Coverage Δ
gap/base/methsel.gd	100.00% <ø> (ø)
gap/matrix/slconstr.gi	5.88% <ø> (ø)

[danielrademacher]

Yes, that's great to know! Thanks!
I have to check what function is used in Akos and Max code and to run some tests which functions are currently best in GAP for constructive recognition.

And I agree with Sergio, we should rename the function and choose clearer names to differentiate which function does what. The names should be chosen consistently in a certain way. Then it would be easier for users and programmers of the package. But that is probably connected with an enormous amount of effort. Shall we open an issue about this?

[ssiccha]

@danielrademacher To in general come up with better names for many functions we already have an issue, see #177 and our note with proposals for new names which we made during the summer school. For #177 @FriedrichRober and I only looked into the documented names though. Thanks for the comment, I'm looking into finding a few names from our proposal note to open a PR with. That has also been lying around for way too long.

Back to the FindHom function. That one was not documented before. So we didn't consider it for #177 yet. Also we had not thought about a naming scheme for leaf methods yet. I guess in the documentation we should also separate the splitting methods and the leaf methods.

[ssiccha]

@danielrademacher See #253.

[fingolfin]

Iissue #257 would also take care of this comment

[ssiccha]

I'm removing this change and will do #257 and #258 next.

[ssiccha]

Added suggestions and rebased.

[danielrademacher]

Looks good.