On May 16, 1:10 pm, Robert Bradshaw <rober...@math.washington.edu>
wrote:
> On May 16, 2009, at 3:16 AM, Michel wrote:
>
> > Here is one thing I find difficult to use about sage: the help system.
>
> That's surprising, because it's something a lot of people really find
> nice.
>
>
>
> > When in my previous post the symbolic "solve" command failed on me I
> > wanted to use
> > a numeric solve command. So I did
>
> > solve?
>
> > Alas the help page that is returned does not contain a "See also"
> > section. So this didn't work.
>
> > So I brought up the reference manual but again it was not obvious how
> > to proceed. I typed
> > "numerical" in the Quick Search box only to get a long list of pages
> > that did not seem useful immediately.
>
> > As an experiment I did the same in maple. I typed
>
> > ?solve
>
> > It brought up a nice manpage with a See Also section
>
> > See Also
> > dsolve - solve an ordinary differential equation (ODE) or system of
> > ODEs,
> > fsolve - solve equations and inequalities using numeric methods,
> > LinearAlgebra[LinearSolve] - solve a linear system A . x = b,
> > pdsolve - solve a partial differential equation (PDE) or system of
> > PDEs,
> > RealDomain - provide a real number context,
> > RootOf - implicit representation for roots of equations,
> > solve/details - detailed information about the solve command,
> > SolveTools - solve a system of algebraic equations using low-level
> > commands
>
> > I would be very useful is sage did something similar.
>
> Yes, it would be! You can just edit sage/calculus/equations.py
> (inside devel/sage of wherever you have it installed) and send us the
> patch. At least that process has lots of documentation:
> http://www.sagemath.org/doc/developer/producing_patches.html
>
> - Robert
Hi, Robert,
I looked on this page.
http://www.sagenb.org/doc/live/developer/conventions.html#documentation-strings
It does not seem possible to include a SEE ALSO section.... So your
suggestion
of "just sending a patch" does not work.
Something else I noted: EXAMPLES is the same as doctests. This seems
strange.
Examples would document common use cases whereas doctests would be
concerned
with corner cases....
I am trying to view this from the point of an ordinary user, not a
developer.
Regards,
Michel
--~--~---------~--~----~------------~-------~--~----~
To post to this group, send email to sage-devel@googlegroups.com
To unsubscribe from this group, send email to
sage-devel-unsubscr...@googlegroups.com
For more options, visit this group at http://groups.google.com/group/sage-devel
URLs: http://www.sagemath.org
-~----------~----~----~----~------~----~------~--~---
