Opened 6 years ago

Last modified 5 years ago

#16871 needs_work enhancement

Dynamic documentation of instances of Expression

Reported by: emassop Owned by:
Priority: minor Milestone: sage-6.5
Component: user interface Keywords:
Cc: kcrisman, jmantysalo, slelievre Merged in:
Authors: Erik Massop Reviewers: Volker Braun
Report Upstream: N/A Work issues:
Branch: u/emassop/t/16871 (Commits) Commit: 1ccdc7a2ff30cacd961385ff700b34b1e47df8d2
Dependencies: Stopgaps:

Description (last modified by emassop)

It would be great if the documentation of symbolic expressions would take the particular expression into account. In particular, if it is a constant, then it should also display the docstring of that constant.

This originates from sage-devel mailing list thread ​About "pi?".

Change History (14)

comment:1 Changed 6 years ago by emassop

  • Branch set to u/emassop/t/16871

comment:2 Changed 6 years ago by git

  • Commit set to 453f8b6e53b9e669b1d78c3c3a4b7cd88910b2c7

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

​453f8b6Dynamic docstrings for Expression instances

comment:3 Changed 6 years ago by git

  • Commit changed from 453f8b6e53b9e669b1d78c3c3a4b7cd88910b2c7 to b7cda7ff035b9f4592ddd7d51e37e5fe58c42734

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

​b7cda7fDynamic docstrings for Expression instances

comment:4 Changed 6 years ago by git

  • Commit changed from b7cda7ff035b9f4592ddd7d51e37e5fe58c42734 to a5a5af38d25e418b76cbc07d925348e4a6c216ec

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

​a5a5af3Dynamic docstrings for Expression instances

comment:5 Changed 6 years ago by emassop

  • Description modified (diff)
  • Status changed from new to needs_review

Someone with more familiarity with how SR is used should probably change the methods that are shown in the docstring.

comment:6 Changed 6 years ago by emassop

  • Authors set to Erik Massop
  • Priority changed from major to minor

comment:7 Changed 6 years ago by kcrisman

  • Cc kcrisman added

comment:8 Changed 6 years ago by git

  • Commit changed from a5a5af38d25e418b76cbc07d925348e4a6c216ec to 7e426358f2c35cf85e846c6b0423ff539d3377b7

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

​963ef87Use sage_getdoc in Expresion.__doc__
​7e42635Add class docstring for sage_getsourcelines

comment:9 Changed 6 years ago by git

  • Commit changed from 7e426358f2c35cf85e846c6b0423ff539d3377b7 to 1ccdc7a2ff30cacd961385ff700b34b1e47df8d2

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

​1ccdc7aMerge tag '6.4.beta4' into t/16871

comment:10 Changed 6 years ago by vbraun

  • Reviewers set to Volker Braun
  • Status changed from needs_review to positive_review

lgtm

comment:11 Changed 6 years ago by vbraun

  • Milestone set to sage-6.5

I don't merge tickets without milestone FYI

comment:12 Changed 6 years ago by vbraun

  • Status changed from positive_review to needs_work

Documentation doesn't build (make doc fails).

comment:13 Changed 5 years ago by jmantysalo

  • Cc jmantysalo added

CC'ing myself. log2 has the same problem.

comment:14 Changed 5 years ago by slelievre

  • Cc slelievre added
Note: See TracTickets for help on using tickets.