I was just looking at a post of Minh's, in which he suggested others had
suggested adding to docstrings the names of related commands. That seems very
sensbile - just like the "man" pages of a Unix system.
How would people feel about providing links to MathWorld and Wikipedia on the
docstrings too?
i.e. for "norm"
http://trac.sagemath.org/sage_trac/ticket/8825
add links to
http://en.wikipedia.org/wiki/Matrix_norm
http://mathworld.wolfram.com/Norm.html
http://mathworld.wolfram.com/MatrixNorm.html
http://mathworld.wolfram.com/VectorNorm.html
IMHO, it would also be worth adding the nearest equivalent commands in Macsyma,
Mathematica, Maple and MATLAB, though I doubt that will be possible for many
commands. sin() would have
Sin[] - nearest equivalent command for Mathematica
sin() - nearest equivalent command for MATLAB
I don't know about the command for 'sine' in other packages, but no doubt
someone is familiar with them.
One could also add for packages where there is no similar command for the
commercial packages.
foobar() - As of version 7.0, Mathematica has no similar functionality.
I think at one point, providing a list of equivalent commands in these packages
should be done, to aid people porting code from these packages to Sage. A start
would be to document the nearest equivalent commands in the actual docstrings.
At least if a conversion list was ever made, the docstrings would provide some
help to those compiling such a list.
Dave
--
To post to this group, send an email to [email protected]
To unsubscribe from this group, send an email to
[email protected]
For more options, visit this group at http://groups.google.com/group/sage-devel
URL: http://www.sagemath.org
