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

Macro for docstring of universal functions #2094

Open
albinahlback opened this issue Oct 15, 2024 · 0 comments
Open

Macro for docstring of universal functions #2094

albinahlback opened this issue Oct 15, 2024 · 0 comments

Comments

@albinahlback
Copy link
Collaborator

albinahlback commented Oct 15, 2024

Came to mind while comparing the current docstring of fmpz_poly_is_squarefree with fq_poly_is_squarefree: Given two similar functions, they should more or less have the same docstring.

An easy way to

  • ensure consistency throughout FLINT docs,
  • try to enforce a specific definition throughout FLINT,
  • with less code,

would therefore be to have macros for such docstrings. Not sure how to achieve this in the Sphinx, but feels very achievable.

Very reasonable thing to do during the workshop.

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

No branches or pull requests

1 participant