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

Decide how to document functions like is_trivial, is_irreducible with many different methods in a consistent way... docstrings vs. manual vs. REPL etc. #1471

Open
HereAround opened this issue Jul 20, 2022 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@HereAround
Copy link
Member

No description provided.

@HereAround HereAround changed the title ToricVarieties: Make @refs (for is_trivial, is_irreducible etc) to add them to the search index of the documentation ToricVarieties: Insert @refs (e.g. for is_trivial, is_irreducible etc) so that these places appear in the search index of the documentation Jul 20, 2022
@HereAround HereAround added documentation Improvements or additions to documentation topic: toric varieties labels Jul 22, 2022
@fingolfin fingolfin changed the title ToricVarieties: Insert @refs (e.g. for is_trivial, is_irreducible etc) so that these places appear in the search index of the documentation Decide how to document functions like is_trivial, is_irreducible with many different methods in a consistent way... docstrings vs. manual vs. REPL etc. Dec 12, 2022
@thofma
Copy link
Collaborator

thofma commented Feb 1, 2025

Small remark from #4509

In case there is a common supertype (like RingElem, Ring, Ideal), we want to document the mathematical notion directly for this supertype. For example, that dim(R::Ring) should return the Krull dimension etc, without putting a dim docstring at every possible type, e.g., dim(::MPolyRing), dim(...). But as far as I understand, it is not clear if this makes sense for ==.

In the dim example, one has a "problem" with the online documentation, since one ideally wants to include the dim docstring in the documentation of polynomial rings, ideals, ..., etc, together with examples.

@fingolfin fingolfin removed the triage label Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants