#9690: explain differences between standard, optional, and experimental packages
-----------------------------+----------------------------------------------
Reporter: mvngu | Owner: mvngu
Type: enhancement | Status: new
Priority: major | Milestone: sage-4.6.1
Component: documentation | Keywords:
Author: | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-----------------------------+----------------------------------------------
Comment(by drkirkby):
A few comments
== Supported platforms ==
This bit of the developers guide should have a link to
http://wiki.sagemath.org/SupportedPlatforms where the supported platforms
are listed. (There needs to be other links in other parts of the
developers and user's guide too, but this is one place where a link needs
to be). Otherwise people wont know what platforms their optional packages
are supposed to be tested on.
== Optional packages ==
There should be a comment that optional packages must work on all
supported platforms unless there is a '''very''' good reason why it can't
be run on all platforms. (Valgrid is the obvious example of where there's
a very good reason). What I am keen to avoid is an optional package,
saying "It's only supported on Linux", and not making sufficient effort to
actually get it working on any other platforms.
I think if optional packages are .spkg files, then there should be an
spkg-check file to run any self-tests that package may have.
== Experimental packages ==
Although it should not be a requirement, I think we should say people are
'''encouraged''' to add doc tests and if appropriate an {{{SPKG.txt}}} and
{{{spkg-check}}} file.
Is anyone intending to write this? I would like to see this in the
developers guide, but don't know how to write the documentation myself,
and have so many tickets I'm involved in now, this is not something I have
a lot of time for myself. Someone who knows what they are doing can
probably do it in a tenth of the time I could.
Dave
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/9690#comment:3>
Sage <http://www.sagemath.org>
Sage: Creating a Viable Open Source Alternative to Magma, Maple, Mathematica,
and MATLAB
--
You received this message because you are subscribed to the Google Groups
"sage-trac" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/sage-trac?hl=en.
