sagemath / sage

Main repository of SageMath
https://www.sagemath.org
Other
1.28k stars 438 forks source link

(very) Minor improvements to the multivariate polynomials documentation #13716

Open 89f39f15-88e8-4e79-9bc0-0739a7fc497c opened 11 years ago

89f39f15-88e8-4e79-9bc0-0739a7fc497c commented 11 years ago

Mostly typo fixing, adding references to trac tickets, adding quotes, fixing a few spelling mistakes, ...

Component: commutative algebra

Author: Charles Bouillaguet

Issue created by migration from https://trac.sagemath.org/ticket/13716

89f39f15-88e8-4e79-9bc0-0739a7fc497c commented 11 years ago
comment:1

Attachment: 13716_improve_multipolynomial_doc.patch.gz

ppurka commented 11 years ago
comment:2

Some comments:

  1. Line 1308 is missing a backtick on closing.
Returns the leading term of ``self`` i.e., ``self.lc()*self.lm()`. The
  1. 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``. 
  1. Shouldn't line 1975 also have \ne in the latter expression?
        - `LT(g_i) \neq LT(g_j)` for all `i != j` 
  1. 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.
  2. 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.
  3. 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. :)
DaveWitteMorris commented 4 years ago
comment:8

Removing the "beginner" tag from old tickets. Some could be returned to beginner-friendly status by adding a comment about what needs to be done. Some others might be easy for an experienced developer to finish.