Ticket #2240 (closed enhancement: fixed)

Opened 5 years ago

Last modified 5 years ago

[with patches, positive review] Docstrings and Doctests: calculus.py

Reported by: cswiercz Owned by: cswiercz
Priority: major Milestone: sage-2.10.3
Component: documentation Keywords: docstring, doctest
Cc: Work issues:
Report Upstream: Reviewers:
Authors: Merged in:
Dependencies: Stopgaps:

Description

Goal: Enter all missing docstrings and doctests for functions (not beginning with an underscore "_") in the file

calculus/calculus.py.

Attachments

8311_ff813e90293c.patch Download (2.5 KB) - added by cswiercz 5 years ago.
8312_bb733c0e5ec6.patch Download (1.2 KB) - added by cswiercz 5 years ago.
8313_2fbe4cb29f57.patch Download (5.6 KB) - added by cswiercz 5 years ago.
8311_ff813e90293c.2.patch Download (2.5 KB) - added by mhansen 5 years ago.
2240.patch Download (4.8 KB) - added by mhansen 5 years ago.

Change History

comment:1 Changed 5 years ago by cswiercz

  • Owner changed from tba to cswiercz

comment:2 Changed 5 years ago by cswiercz

  • Keywords docstring, doctest added
  • Milestone set to sage-2.10.2

Changed 5 years ago by cswiercz

Changed 5 years ago by cswiercz

Changed 5 years ago by cswiercz

comment:3 Changed 5 years ago by cswiercz

Attached are patches including docstrings and doctests for some (but not all) functions without docstrings in calculus.py. There are still some low-level functions in calculus.py that require docstrings. However, the author of these patches isn't familiar enough with the functions to do them justice.

comment:4 Changed 5 years ago by cswiercz

  • Status changed from new to assigned

comment:5 Changed 5 years ago by mabshoff

  • Priority changed from minor to major
  • Summary changed from Docstrings and Doctests: calculus.py to [with patches, need review] Docstrings and Doctests: calculus.py

Changed 5 years ago by mhansen

comment:6 Changed 5 years ago by mhansen

  • Summary changed from [with patches, need review] Docstrings and Doctests: calculus.py to [with patches, positive review] Docstrings and Doctests: calculus.py

Looks good to me. I've added the last patch which replaces the first and fixes the wont-typo.

comment:7 Changed 5 years ago by mabshoff

  • Summary changed from [with patches, positive review] Docstrings and Doctests: calculus.py to [with patches, positive review, needs rebase] Docstrings and Doctests: calculus.py

No dice, i.e. rejects for all patches: 

mabshoff@sage:/scratch/mabshoff/release-cycle/sage-2.10.3.alpha0/devel/sage$ patch -p1 --dry-run < trac_2240_8311-2.patch
patching file sage/calculus/calculus.py
Hunk #1 FAILED at 4409.
1 out of 1 hunk FAILED -- saving rejects to file sage/calculus/calculus.py.rej
patching file sage/misc/hg.py
Hunk #1 succeeded at 169 (offset 32 lines).
mabshoff@sage:/scratch/mabshoff/release-cycle/sage-2.10.3.alpha0/devel/sage$ patch -p1 --dry-run < trac_2240_8312.patch
patching file sage/calculus/calculus.py
Hunk #1 FAILED at 437.
1 out of 1 hunk FAILED -- saving rejects to file sage/calculus/calculus.py.rej
mabshoff@sage:/scratch/mabshoff/release-cycle/sage-2.10.3.alpha0/devel/sage$ patch -p1 --dry-run < trac_2240_8313.patch
patching file sage/calculus/calculus.py
Hunk #1 FAILED at 449.
Hunk #2 FAILED at 2545.
Hunk #3 FAILED at 2625.
Hunk #4 FAILED at 5817.
Hunk #5 FAILED at 6459.
Hunk #6 FAILED at 6541.
Hunk #7 FAILED at 6813.
7 out of 7 hunks FAILED -- saving rejects to file sage/calculus/calculus.py.rej

Cheers,

Michael

Changed 5 years ago by mhansen

comment:8 Changed 5 years ago by mhansen

  • Summary changed from [with patches, positive review, needs rebase] Docstrings and Doctests: calculus.py to [with patches, positive review] Docstrings and Doctests: calculus.py

New patch posted.

comment:9 Changed 5 years ago by mabshoff

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

Merged 2240.patch in Sage 2.10.3.alpha0

Note: See TracTickets for help on using tickets.