Opened 8 years ago

Closed 8 years ago

#13512 closed enhancement (fixed)

Docstring formatting in misc_c.pyx

Reported by: fwclarke Owned by: mvngu
Priority: minor Milestone: sage-5.4
Component: documentation Keywords: docstring format, beginner
Cc: Merged in: sage-5.4.rc1
Authors: Francis Clarke Reviewers: Jeroen Demeyer
Report Upstream: N/A Work issues:
Branch: Commit:
Dependencies: Stopgaps:

Description

sage/misc/misc_c.pyx needs some double colons and blank lines. For example

sage: prod?
...
       EXAMPLES:
          sage: prod([1,2,34]) 68 sage: prod([2,3], 5) 30 sage:
          prod((1,2,3), 5) 30 sage: F = factor(-2006); F -1 * 2 * 17 * 59
          sage: prod(F) -2006
...

The patch should solve the problem.

Attachments (1)

trac13512_docstring_format.patch (3.8 KB) - added by fwclarke 8 years ago.
replaces previous patch of the same name

Download all attachments as: .zip

Change History (8)

comment:1 Changed 8 years ago by fwclarke

  • Keywords beginner added
  • Status changed from new to needs_review

comment:2 follow-up: Changed 8 years ago by jdemeyer

  • Status changed from needs_review to needs_work

Changed 8 years ago by fwclarke

replaces previous patch of the same name

comment:3 in reply to: ↑ 2 Changed 8 years ago by fwclarke

Replying to jdemeyer:

AUTHORS: should be left as it was

The replacement patch complies with the coding conventions.

comment:4 Changed 8 years ago by jdemeyer

  • Reviewers set to Jeroen Demeyer
  • Status changed from needs_work to positive_review

comment:5 Changed 8 years ago by jdemeyer

  • Milestone changed from sage-5.4 to sage-5.5

comment:6 Changed 8 years ago by jdemeyer

  • Milestone changed from sage-5.5 to sage-5.4

comment:7 Changed 8 years ago by jdemeyer

  • Merged in set to sage-5.4.rc1
  • Resolution set to fixed
  • Status changed from positive_review to closed
Note: See TracTickets for help on using tickets.