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

change dsage docstrings to match rest of sage #2319

Closed
yqiang mannequin opened this issue Feb 26, 2008 · 2 comments
Closed

change dsage docstrings to match rest of sage #2319

yqiang mannequin opened this issue Feb 26, 2008 · 2 comments

Comments

@yqiang
Copy link
Mannequin

yqiang mannequin commented Feb 26, 2008

Currently much of the dsage docstrings are written using reST syntax which apparently Sage does not use. It should be rewritten to be more like the other Sage docstrings. An alternative is for new Sage documentation to be written in something like reST which would allow much easier API doc generation through something like epydoc.

Component: dsage

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

@yqiang yqiang mannequin added this to the sage-4.3.1 milestone Feb 26, 2008
@yqiang yqiang mannequin added c: dsage labels Feb 26, 2008
@yqiang yqiang mannequin self-assigned this Feb 26, 2008
@williamstein
Copy link
Contributor

comment:1

Currently much of the dsage docstrings are written using reST syntax
which apparently Sage does not use. It should be rewritten to be more
like the other Sage docstrings.
An alternative is for new Sage
documentation to be written in something like reST which would
allow much easier API doc generation through something like epydoc.

Some comments:

  • Sage is MATH SOFTWARE, and as such reST is not what we want -- Latex very much is what we want. For math, Latex is by far the best choice. We're definitely not changing the docstring format in the rest of Sage (not an option).

  • DSage -- except for the examples -- is not specifically math software. For dsage, latex is potentially just a nuisance.

Just keep those points in mind when thinking about this issue.

@williamstein
Copy link
Contributor

comment:2

Dsage has been deprecated.

@sagetrac-mvngu sagetrac-mvngu mannequin removed this from the sage-4.3.1 milestone Jan 19, 2010
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

1 participant