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

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

Closed
cheuberg opened this issue Jul 21, 2014 · 16 comments
Closed

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

cheuberg opened this issue Jul 21, 2014 · 16 comments

Comments

@cheuberg
Copy link
Contributor

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.

CC: @dkrenn @kcrisman

Component: symbolics

Keywords: assumptions, assume

Author: Frédéric Chapoton, Clemens Heuberger

Branch/Commit: fb6f620

Reviewer: Clemens Heuberger, Ralf Stephan

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

@cheuberg cheuberg added this to the sage-6.3 milestone Jul 21, 2014
@kcrisman
Copy link
Member

comment:2

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!

@fchapoton
Copy link
Contributor

Changed commit from ec70176 to 4e45a5c

@fchapoton
Copy link
Contributor

comment:3

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

@fchapoton
Copy link
Contributor

@cheuberg
Copy link
Contributor Author

comment:4

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?

@fchapoton
Copy link
Contributor

comment:5

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

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 28, 2014

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

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 28, 2014

Changed commit from 4e45a5c to be0ad45

@cheuberg
Copy link
Contributor Author

Reviewer: Clemens Heuberger

@cheuberg
Copy link
Contributor Author

comment:7

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.

@cheuberg
Copy link
Contributor Author

Changed author from Clemens Heuberger to Frédéric Chapoton, Clemens Heuberger

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 28, 2014

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

fb6f62016695: reviewer's patch improving some synopsis and latex

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented Jul 28, 2014

Changed commit from be0ad45 to fb6f620

@rwst
Copy link

rwst commented Jul 28, 2014

Changed reviewer from Clemens Heuberger to Clemens Heuberger, Ralf Stephan

@rwst
Copy link

rwst commented Jul 28, 2014

comment:9

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

@vbraun
Copy link
Member

vbraun commented Jul 28, 2014

Changed branch from public/ticket/16695 to fb6f620

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants