#7939: shorten doctests in sage/rings/multi_polynomial_ideal.py
-------------------------------+--------------------------------------------
Reporter: rlm | Owner: tbd
Type: defect | Status: needs_info
Priority: major | Milestone: sage-4.3.2
Component: interfaces | Keywords:
Author: Martin Albrecht | Upstream: N/A
Reviewer: | Merged:
Work_issues: |
-------------------------------+--------------------------------------------
Comment(by PolyBoRi):
> What would I like to see? (I'm not sure if this is feasible without a
lot of work, but here goes.) If I type {{{groebner?}}} I want to know how
to use {{{groebner}}} from Sage. For instance, seeing the example
>
> {{{
> sage: groebner = sage.libs.singular.ff.groebner
> sage: P.<x, y> = PolynomialRing(QQ)
> sage: I = P.ideal(x^2-y, y+x)
> sage: groebner(I)
> [x + y, y^2 - y]
> }}}
>
> and maybe a couple more showing other arguments/options would get me
started with using the function. So I would think that it's more useful
and natural to have something like the above, followed by the Singular
help that shows all the options, bells, and whistles. Again, I don't know
if this is feasible, but it would be nice.
>
> If that's not possible, maybe have a docstring that shows how to use
some of the more popular Singular functions from Sage. If that's followed
by the Singular help for the particular function I'm looking at at the
moment, I should be able to put the two together and understand how to do
things.
IMHO Sage specific documentation belongs in the layer around this generic
Singular interface.
You can construct singular functions add wrap them in Sage
functions/methods of Sage classes...
This means having orthogonality: The LibSingularFunction is responsible
for calling Singular and gives Singulars original docs.
In the wrapper around you can do the Sage specific stuff, which includes
documentation, but also making the interface more Pythonic.
E.g. for groebner you might like to introduce keyword args.
{{{
Singular:
groebner(i,"par2var","slimgb");
}}}
{{{
Pythonic:
groebner(i,algorithms=["slimgb", "std"])
}}}
But that would be the responsible of another layer;-).
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/7939#comment:16>
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.
