Ticket #4910 (closed defect: fixed)

Opened 4 years ago

Last modified 4 years ago

[with patch, positive review after a fast re-reading] convert sage.functions.* docstrings to Sphinx

Reported by: mhansen Owned by: mhansen
Priority: major Milestone: sage-3.4
Component: documentation Keywords:
Cc: Work issues:
Report Upstream: Reviewers:
Authors: Merged in:
Dependencies: Stopgaps:

Description


Attachments

trac_4910.patch Download (181.3 KB) - added by mhansen 4 years ago.
sage.functions-final.patch Download (176.4 KB) - added by mhansen 4 years ago.
sage.functions-final-fixed.patch Download (176.4 KB) - added by hivert 4 years ago.
New patch with hand fix.

Change History

Changed 4 years ago by mhansen

comment:1 follow-up: ↓ 2 Changed 4 years ago by mhansen

  • Summary changed from convert sage.functions.* docstrings to Sphinx to [with patch, needs review] convert sage.functions.* docstrings to Sphinx

Changed 4 years ago by mhansen

comment:2 in reply to: ↑ 1 Changed 4 years ago by hivert

I've found some minor problem in the patch:

-  Each *Legendre polynomial* `P_n(x)` is an $n$-th degree polynomial. 

Should be

-  Each *Legendre polynomial* `P_n(x)` is an `n`-th degree polynomial. 

And a little bit lower:

 The *Legendre function of the second kind* $Q_n(x)$ is another 

Should be

 The *Legendre function of the second kind* `Q_n(x)` is another 

A whole section

Implemented methods: 
  9 latex outout 
  10 __call__ 
[...]
  39 extend_by_zero_to 
  40 unextend 

seems to have vanished.

comment:3 Changed 4 years ago by hivert

  • Summary changed from [with patch, needs review] convert sage.functions.* docstrings to Sphinx to [with patch, positive review after a fast re-reading] convert sage.functions.* docstrings to Sphinx

I've manually edited the patch to fixes the two "$" vs "`" problems. The corrected patch should follow.

The section implemented methods is removed on purpose (it is redundent with the code). Otherwise it seems Ok.

As for combinat, my rereading was a fast rereading. In particular, There are a lot of formulas that needs time to be checked carfully.

Changed 4 years ago by hivert

New patch with hand fix.

comment:4 Changed 4 years ago by mhansen

  • Owner changed from tba to mhansen
  • Status changed from new to assigned

I put these changes in the fixes.patch in #5330.

comment:5 Changed 4 years ago by mabshoff

  • Status changed from assigned to closed
  • Resolution set to fixed

Merged sage.functions-final-fixed.patch in Sage 3.4.alpha0.

Cheers,

Michael

Note: See TracTickets for help on using tickets.