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

Missing or incomplete docstrings for various ring constructors #1508

Open
9 tasks
fingolfin opened this issue Nov 22, 2023 · 0 comments
Open
9 tasks

Missing or incomplete docstrings for various ring constructors #1508

fingolfin opened this issue Nov 22, 2023 · 0 comments

Comments

@fingolfin
Copy link
Member

  • free_associative_algebra has no docstring
  • @free_associative_algebra has no docstring
  • laurent_polynomial_ring docstring for multivariate case has no examples
  • @laurent_polynomial_ring has no docstring
  • power_series_ring docstring for univariate case has no examples
  • power_series_ring docstring for multivariate case is missing
  • @power_series_ring has no docstring
  • rational_function_field has no docstring
  • @rational_function_field has no docstring

Note that in several cases, text and examples suitable for a docstring can be found in the doc/*/*.md files and could be extracted from there (and replaced with a @docs block in the .md file).

In any case, I would recommend to focus on one of these (e.g. free_associative_algebra), and write good docstrings for it; then hopefully those can be copied to the other cases with minor adaptions.

Actually I guess one could use polynomial_ring as that starting point, but I am not sure the docstrings for it are great yet, so perhaps first improve them; I'd also argue it has too many docstrings, some of which should perhaps be consolidated, but that's a matter of taste.

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