Opened 6 years ago

Closed 6 years ago

#16695 closed defect (fixed)

Add src/sage/symbolic/assumptions to the reference manual

Reported by: cheuberg Owned by:
Priority: minor Milestone: sage-6.3
Component: symbolics Keywords: documentation, assumptions, assume
Cc: dkrenn, kcrisman Merged in:
Authors: Frédéric Chapoton, Clemens Heuberger Reviewers: Clemens Heuberger, Ralf Stephan
Report Upstream: N/A Work issues:
Branch: fb6f620 (Commits) Commit: fb6f6209ae7d8cfeb66b1ec0341fc3875ccb12f0
Dependencies: Stopgaps:

Description

The file src/sage/symbolic/assumptions.py was not part of the reference manual; therefore, the documentation of the global function assume() etc. was not in the reference manual.

See the discussion at https://groups.google.com/forum/#!topic/sage-devel/pb5C1xPTU7c .

This simple patch adds it to reference/calculus.

Change History (10)

comment:1 Changed 6 years ago by cheuberg

  • Status changed from new to needs_review

comment:2 Changed 6 years ago by kcrisman

Yeah, doesn't even seem to need much sprucing up - maybe changing to :trac:`12345` format or something. Possibly putting some of the GenericDeclaration info where it will be seen (underscore methods aren't in the reference manual, including init)... I don't have access to actually testing this builds properly in the manual but seems like the right move!

comment:3 Changed 6 years ago by chapoton

  • Branch changed from u/cheuberg/symbolic/assumptions-reference-manual to public/ticket/16695
  • Commit changed from ec70176790709a85da140888620da1e9028dd35e to 4e45a5c8f31a07c6d8569e305fdc7f6f48b4e61c

I have made little tweaks to the doc, including

  • copied some doc from _init_ to the class GenericDeclaration
  • used twice the trac role :trac: to link to tickets
  • a few other minor change

New commits:

4e45a5ctrac #16695 little doc improvements, also taking care of trac role

comment:4 Changed 6 years ago by cheuberg

This seems to be a brand-new branch not including my minimalistic branch. Therefore, it seems that assumptions.py is not included into the reference manual. If there a reason for that or is it a simple oversight?

comment:5 Changed 6 years ago by chapoton

Oops, sorry, looks like I have made a mistake. Should I take care of that, or are you going to do it ?

comment:6 Changed 6 years ago by git

  • Commit changed from 4e45a5c8f31a07c6d8569e305fdc7f6f48b4e61c to be0ad45ca3bb9cfca62b9a64cabc456c1f7ed2c8

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

ec70176Add sage/symbolic/assumptions to the reference manual (with a simple title)
06d837fMerge branch 'u/cheuberg/symbolic/assumptions-reference-manual' of trac.sagemath.org:sage into t/16695/public/ticket/16695
7f937catrac #16695: further doctest
be0ad45trac #16695: Minor formatting improvements in docstrings; added one description

comment:7 Changed 6 years ago by cheuberg

  • Authors changed from Clemens Heuberger to Frédéric Chapoton, Clemens Heuberger
  • Reviewers set to Clemens Heuberger

I merged my old branch so that the changes now actually show up in the reference manual. I reviewed your changes and amended a few details.

comment:8 Changed 6 years ago by git

  • Commit changed from be0ad45ca3bb9cfca62b9a64cabc456c1f7ed2c8 to fb6f6209ae7d8cfeb66b1ec0341fc3875ccb12f0

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

fb6f62016695: reviewer's patch improving some synopsis and latex

comment:9 Changed 6 years ago by rws

  • Reviewers changed from Clemens Heuberger to Clemens Heuberger, Ralf Stephan
  • Status changed from needs_review to positive_review

I added two minor fixes. Hope it's OK if I set positive?

comment:10 Changed 6 years ago by vbraun

  • Branch changed from public/ticket/16695 to fb6f6209ae7d8cfeb66b1ec0341fc3875ccb12f0
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.