Opened 3 years ago

Last modified 3 years ago

#23657 needs_work enhancement

Improve Expression member function documentation

Reported by: rws Owned by:
Priority: major Milestone: sage-8.1
Component: documentation Keywords:
Cc: Merged in:
Authors: Ralf Stephan Reviewers:
Report Upstream: N/A Work issues:
Branch: u/rws/23657-1 (Commits) Commit: 3ba45db080554586c0c4eeb8e91a0968a9025ee3
Dependencies: #23670 Stopgaps:

Description

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

Change History (8)

comment:1 Changed 3 years ago by rws

  • Branch set to u/rws/23657

comment:2 Changed 3 years ago by rws

  • Branch changed from u/rws/23657 to u/rws/23657-1

comment:3 Changed 3 years ago by rws

  • Authors set to Ralf Stephan
  • Commit set to 10397499b65791e6064371d2b44733d28e59117c
  • Status changed from new to needs_review

New commits:

​103974923657: Improve Expression member function documentation

comment:4 Changed 3 years ago by git

  • Commit changed from 10397499b65791e6064371d2b44733d28e59117c to 3ba45db080554586c0c4eeb8e91a0968a9025ee3

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

​3ba45db23657: fixes

comment:5 Changed 3 years ago by tscrim

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.

comment:6 Changed 3 years ago by rws

  • Status changed from needs_review to needs_work

comment:7 Changed 3 years ago by rws

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

comment:8 Changed 3 years ago by rws

  • Dependencies set to #23670

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

Note: See TracTickets for help on using tickets.