Opened 6 years ago

Last modified 4 years ago

#13716 needs_work enhancement

(very) Minor improvements to the multivariate polynomials documentation

Reported by: Bouillaguet Owned by: malb
Priority: trivial Milestone: sage-6.4
Component: commutative algebra Keywords: beginner
Cc: Merged in:
Authors: Charles Bouillaguet Reviewers:
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

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

Attachments (1)

13716_improve_multipolynomial_doc.patch (53.2 KB) - added by Bouillaguet 6 years ago.

Download all attachments as: .zip

Change History (8)

Changed 6 years ago by Bouillaguet

comment:1 Changed 6 years ago by Bouillaguet

  • Status changed from new to needs_review

comment:2 Changed 6 years ago 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. :)

comment:3 Changed 6 years ago by malb

  • Status changed from needs_review to needs_work

comment:4 Changed 5 years ago by jdemeyer

  • Milestone changed from sage-5.11 to sage-5.12

comment:5 Changed 5 years ago by vbraun_spam

  • Milestone changed from sage-6.1 to sage-6.2

comment:6 Changed 5 years ago by vbraun_spam

  • Milestone changed from sage-6.2 to sage-6.3

comment:7 Changed 4 years ago by vbraun_spam

  • Milestone changed from sage-6.3 to sage-6.4
Note: See TracTickets for help on using tickets.