Skip to content

Conversation

@AnnaKDS
Copy link
Collaborator

@AnnaKDS AnnaKDS commented Dec 11, 2025

I am working on improving the documentation to include a chapter that is particularly directed to people who want to recognise groups with this package and don't have much theoretical background.

It's still WIP but if you have any suggestions, please feel free to comment.

@codecov
Copy link

codecov bot commented Dec 11, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.55%. Comparing base (6d84867) to head (6fe6992).
⚠️ Report is 20 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #364      +/-   ##
==========================================
- Coverage   78.55%   71.55%   -7.01%     
==========================================
  Files          43       43              
  Lines       18281    18398     +117     
==========================================
- Hits        14361    13164    -1197     
- Misses       3920     5234    +1314     

see 24 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ThomasBreuer
Copy link

some general remarks:

  • The introduction distinguishes "naming" and "constructive recognition".
    Can a user ask just for the result of the "naming" phase, or is the result of the user functions always that of the "constructive recognition"? In the latter case, the distinction of the two phases belongs to a more technical part of the manual.
  • Chapter "Group recognition" distinguishes a "recognition phase" and a "verification phase".
    What is the status of the results of RecognizeGroup: Is the return value always verified, or may it be incorrect? Asked the other way round: Can one ask for a result without verification?


Chapter <Ref Chap="recognition"/> describes the generic, recursive procedure
used for group recognition throughout this package. At the heart of this
procedure is the definition of <Q>FindHomomorphism</Q> methods, which is also

This comment was marked as duplicate.

@fingolfin
Copy link
Member

@ThomasBreuer currently verification is not implemented. But it definitely should be made possible for the user to control whether verification happens; and also perhaps certain probabilities.

Copy link
Member

@frankluebeck frankluebeck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a welcome improvement of the recog documentation.

I have added a few more comments.

After addressing the current comments this should be merged soon. Of course, it can be further improved any time later.

@fingolfin
Copy link
Member

I agree with @frankluebeck: I'd rather merge this sooner than later. Even if there are still TODO comment in there. Once it is merged, follow-up PRs can further improve things.

@AnnaKDS AnnaKDS marked this pull request as ready for review January 20, 2026 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants