-
Notifications
You must be signed in to change notification settings - Fork 7
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Readd Transf #163
Readd Transf #163
Conversation
7ed0b24
to
5bf3ff9
Compare
I think this is ready to go, @Joseph-Edwards |
Modulo the tests passing (which I assume they will after libsemigroups/libsemigroups#544 is merged) and my minor suggestion above, this looks good to me. That said, I'd like to build and read the docs just to be doubly sure. I'll do this first thing tomorrow morning. |
3626aab
to
ee3be16
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've read had a more thorough read through the docs now, and it all looks very good to me. I have a few minor comments before I'd be happy to merge.
- For consistency, should the new pages in the doc have a table of contents as in
Action
andKnuth-Bendix
? - After the signatures of some of the functions, some return types have hyperlinks and some don't. For example, in
PPerm(dom: List[int], img: List[int], deg: int) → StaticPPerm16 | PPerm1 | PPerm2 | PPerm4
,StaticPPerm16
gets a hyperlink, but the others don't. It's not immediately clear if there's a nice fix for this (or if a nice fix is even necessary), but it would be nice to do if there is. - If I understood correctly, @james-d-mitchell asked if it was possible to show the constructor when documenting a class. I couldn't remember how to do that at the time, but I now recall that is done with something like this:
.. autoclass:: StaticTransf16
:class-doc-from: class
:members:
:inherited-members:
:special-members: __init__
With the above comments considered, I would be happy to merge
4ed2f52
to
dac1a07
Compare
Co-authored-by: Joe Edwards <[email protected]>
dac1a07
to
2524300
Compare
Co-authored-by: Joe Edwards <[email protected]>
2524300
to
472cf2a
Compare
No description provided.