#13716: (very) Minor improvements to the multivariate polynomials documentation
---------------------------------------+------------------------------------
Reporter: Bouillaguet | Owner: malb
Type: enhancement | Status: needs_review
Priority: trivial | Milestone: sage-5.5
Component: commutative algebra | Resolution:
Keywords: beginner | Work issues:
Report Upstream: N/A | Reviewers:
Authors: Charles Bouillaguet | Merged in:
Dependencies: | Stopgaps:
---------------------------------------+------------------------------------
Comment (by ppurka):
Some comments:
1. Line 1308 is missing a backtick on closing.
{{{
Returns the leading term of ``self`` i.e., ``self.lc()*self.lm()`. The
}}}
2. Lines 1577 and 1578 should have the latex variables enclosed in single
backticks not double (like {{{`I = (f_1,...,f_r)`}}}:
{{{
given an ideal ``I = (f_1,...,f_r)`` and some ``g (== self)`` in
``I``, find
``s_1,...,s_r`` such that ``g = s_1*f_1 + ... + s_r*f_r``.
}}}
3. Shouldn't line 1975 also have `\ne` in the latter expression?
{{{
- `LT(g_i) \neq LT(g_j)` for all `i != j`
}}}
4. Should we refer to the `derivative()` function in line 342 instead as
{{{:meth:`sage.calculus.functional.derivative`}}} ? This will create a
hyperlink to the derivative documentation in the notebook help.
5. I am not very happy to see lots of "self" throughout the docs, but
converting all of them would be a lot of work. So, I guess we can just let
it pass and hope it gets fixed little by little over time.
6. Most importantly, this patch touches a huge number of lines in several
files. I am ok with this change (in fact, ok with any change which
improves docs), but ultimately its up to Jeroen whether this gets merged,
since he doesn't usually like massive minor changes. :)
--
Ticket URL: <http://trac.sagemath.org/sage_trac/ticket/13716#comment:2>
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.
