Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docstring formatting in misc_c.pyx #13512

Closed
sagetrac-fwclarke mannequin opened this issue Sep 20, 2012 · 5 comments
Closed

Docstring formatting in misc_c.pyx #13512

sagetrac-fwclarke mannequin opened this issue Sep 20, 2012 · 5 comments

Comments

@sagetrac-fwclarke
Copy link
Mannequin

sagetrac-fwclarke mannequin commented Sep 20, 2012

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.

Component: documentation

Keywords: docstring format

Author: Francis Clarke

Reviewer: Jeroen Demeyer

Merged: sage-5.4.rc1

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

@jdemeyer
Copy link

comment:2

AUTHORS: should be left as it was, see http://sagemath.org/doc/developer/conventions.html#headings-of-sage-library-code-files

@sagetrac-fwclarke
Copy link
Mannequin Author

sagetrac-fwclarke mannequin commented Sep 27, 2012

replaces previous patch of the same name

@sagetrac-fwclarke
Copy link
Mannequin Author

sagetrac-fwclarke mannequin commented Sep 27, 2012

comment:3

Attachment: trac13512_docstring_format.patch.gz

Replying to @jdemeyer:

AUTHORS: should be left as it was

The replacement patch complies with the coding conventions.

@jdemeyer
Copy link

Reviewer: Jeroen Demeyer

@jdemeyer
Copy link

jdemeyer commented Oct 5, 2012

Merged: sage-5.4.rc1

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant