Skip to content
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

Rename minpoly -> minimal_polynomial, and charpoly -> characteristic_polynomial? #4517

Open
fingolfin opened this issue Jan 29, 2025 · 0 comments
Labels

Comments

@fingolfin
Copy link
Member

This would make sense based on our naming conventions. Note that the old names must stay for backwards compatibility. (I also like to have these for compact code, just like ngens, but that's a separate matter.

Also note that actual they are already identical. We do this in AA:

@alias characteristic_polynomial charpoly
@alias minimal_polynomial minpoly

So why a change? Because right now if you do ?minimal_polynomial in the REPL when OSCAR is loaded, it shows a bunch of docstrings, among which the info for Alias for minpoly is a bit lost. To get all info you need to enter both ?minpoly and ?minimal_polynomial.

So overall this switch would boil down to this:

  • change in AA which is the alias of which
  • adjust the various docstrings to suggest the long name not the short name
  • perhaps also actively mention the shortnames in the "primary" docstrings?
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants