Improve Expression member function documentation

sagemath / sage

Main repository of SageMath

https://www.sagemath.org

Other

1.31k stars 450 forks source link

Improve Expression member function documentation #23657

Open rwst opened 7 years ago

rwst commented 7 years ago

This 1. moves the current expression.pyx document head to relation.pyx and 2. adds a structured index to expression.pyx member functions.

Depends on #23670

Component: documentation

Author: Ralf Stephan

Branch/Commit: u/rws/23657-1 @ 3ba45db

Issue created by migration from https://trac.sagemath.org/ticket/23657

rwst commented 7 years ago

Branch: u/rws/23657

rwst commented 7 years ago

Changed branch from u/rws/23657 to u/rws/23657-1

rwst commented 7 years ago

Commit: 1039749

rwst commented 7 years ago

Author: Ralf Stephan

rwst commented 7 years ago

New commits:

1039749 23657: Improve Expression member function documentation

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 7 years ago

Branch pushed to git repo; I updated commit sha1. New commits:

3ba45db 23657: fixes

7ed8c4ca-6d56-4ae9-953a-41e42b4ed313 commented 7 years ago

Changed commit from 1039749 to 3ba45db

tscrim commented 7 years ago

comment:5

I really do not like (manual) tables of methods (which are not functions in the strict sense, i.e., you should use :meth: instead of :func:). However, I am willing to set a positive review if you use the automated table as done for graph.py.

rwst commented 7 years ago

comment:7

Great work in graph.py. I might sort the methods in a different ticket. Having an index at all is of immediate importance.

rwst commented 7 years ago

Dependencies: #23670

rwst commented 7 years ago

comment:8

However, we would depend on #23670 because expression.pyx will give the error described there.