#13272: clean up the factor() docstring/interface for univariate polynomials
---------------------------------+------------------------------------------
Reporter: saraedum | Owner: mvngu
Type: task | Status: needs_review
Priority: trivial | Milestone: sage-5.3
Component: documentation | Resolution:
Keywords: beginner | Work issues:
Report Upstream: N/A | Reviewers:
Authors: Julian Rueth | Merged in:
Dependencies: | Stopgaps:
---------------------------------+------------------------------------------
Comment (by saraedum):
Thanks for having a look at my patches.
Replying to [comment:3 ppurka]:
> 1. You can mention class functions in your patches by writing it as
{{{:meth:`._factor_univariate_polynomial`}}} instead of writing that as
{{{`_factor_univariate_polynomial()`}}}. See this
[http://www.sagemath.org/doc/developer/sage_manuals.html#chapter-sage-
manuals-links dev doc] for more details.
That makes sense. I will change the docstrings accordingly.
> 2. I don't understand why you made all the changes like the one below. I
think all these forms of declarations test different ways of calling
and/or declaring the rings or variables. Unless I am mistaken, it should
be good to leave them alone. Maybe someone who knows the code better can
comment.
> {{{
> - sage: C = ComplexField(100)
> - sage: R.<x> = C[]
> +
> + sage: R.<x> = ComplexField(100)[]
> sage: F = factor(x^2+3); F
> }}}
Ok. If this was indeed intended, then I can of course revert these
changes. I just had the feeling that the different constructors should not
be tested in the {{{factor()}}} method. When I was new to sage I found
such docstrings quite confusing because I wondered if these different
constructors had any influence on the code that was actually demonstrated.
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13272#comment:4>
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.
