Opened 12 years ago

Closed 12 years ago

#8132 closed defect (fixed)

fix documentation related to ODE solvers

Reported by: robert.marik Owned by: mvngu
Priority: minor Milestone: sage-4.3.2
Component: documentation Keywords:
Cc: Merged in: sage-4.3.2.rc0
Authors: Robert Mařík Reviewers: David Joyner
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Status badges

Description

The documentation to ODE solvers is not written in harmony with Sage developers guide and the Sage Constructions are outdated.

Attachments (3)

trac_8132.patch (82.0 KB) - added by robert.marik 12 years ago.
trac_8132_fixed_doctests.patch (840 bytes) - added by robert.marik 12 years ago.
fixes one failed doctest, apply on the top of previous poatch
trac_8132_fixed_reference_manual.patch (6.7 KB) - added by robert.marik 12 years ago.
apply on the top of the previous two patches

Download all attachments as: .zip

Change History (10)

Changed 12 years ago by robert.marik

comment:1 Changed 12 years ago by robert.marik

  • Status changed from new to needs_review

comment:2 Changed 12 years ago by robert.marik

this patch

  • fixes indentation in sage/gsl/ode.pyx from 3 spaces to 4 spaces
  • fixes documentation

Changed 12 years ago by robert.marik

fixes one failed doctest, apply on the top of previous poatch

comment:3 Changed 12 years ago by wdj

This seems to be an excellent and extremely welcomed collection of docstring fixes related to solving differential equations in Sage.

Am I missing something or is it odd that calculus/desolver is not listed http://www.sagemath.org/doc/reference/modindex.html? Using

http://www.sagemath.org/doc/developer/sage_manuals.html#building-the-manuals I see how to rebuild the manual but how do I see what the changes in the patch look like if desolver isn't even in the manual in the first place?

Can a patch be added to include desolver in the manual?

comment:4 Changed 12 years ago by robert.marik

Fixed thanks. Thanks for the links how to do it. Two new chapters are at the end of Symbolic Calculus.

PDF manual does not build, partly due to #8036, patly due to another problem not related to this ticket (unknown command \cross used in some file related to polynomials). The ODE part of PDF manual looks good, anyway.

Html version looks good for me.

Changed 12 years ago by robert.marik

apply on the top of the previous two patches

comment:5 Changed 12 years ago by robert.marik

btw: the second problem which caused pdf not to build has been fixed by #8021

comment:6 Changed 12 years ago by wdj

  • Status changed from needs_review to positive_review

Three patches apply fine to 4.3.2.a0 and passes sage -testall, except for apparently unrelated failures already reported, on a mac 10.6.2.

Very nice docstring patch Robert!

Positive review.

comment:7 Changed 12 years ago by mvngu

  • Authors set to Robert Mařík
  • Merged in set to sage-4.3.2.rc0
  • Resolution set to fixed
  • Reviewers set to David Joyner
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.