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

Get rid of "__doc__ =" instead of docstring #20633

Closed
jdemeyer opened this issue May 19, 2016 · 12 comments
Closed

Get rid of "__doc__ =" instead of docstring #20633

jdemeyer opened this issue May 19, 2016 · 12 comments

Comments

@jdemeyer
Copy link

Some Sage modules look like

__doc__ = r"""
docstring here...
"""

Most of these were introduced in #16256. I see no reason at all to have this instead of a normal docstring.

CC: @nthiery @hivert @fchapoton

Component: documentation

Author: Jeroen Demeyer

Branch/Commit: fae960a

Reviewer: Nicolas M. Thiéry

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

@jdemeyer jdemeyer added this to the sage-7.3 milestone May 19, 2016
@jdemeyer
Copy link
Author

Branch: u/jdemeyer/ticket/20633

@jdemeyer
Copy link
Author

Commit: 6abaaf9

@jdemeyer
Copy link
Author

New commits:

6abaaf9Use normal docstring instead of assigning __doc__

@jdemeyer

This comment has been minimized.

@jdemeyer
Copy link
Author

Dependencies: #20617

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 20, 2016

Changed commit from 6abaaf9 to fae960a

@sagetrac-git
Copy link
Mannequin

sagetrac-git mannequin commented May 20, 2016

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

fae960aUse normal docstring instead of assigning __doc__

@jdemeyer
Copy link
Author

Changed dependencies from #20617 to none

@nthiery
Copy link
Contributor

nthiery commented May 20, 2016

comment:7

Hi Jeroen,

Thanks for catching this. I remember trying out several things before converging to this solution, but can't recall why I had used and explicit __doc__ assignment. I may have just confused myself at some point. If everything works without the explicit assignment, and I don't see why not, that's certainly much better. I have double checked for introspection and doc building. So positive review!


New commits:

fae960aUse normal docstring instead of assigning __doc__

@jdemeyer
Copy link
Author

Reviewer: Nicolas M. Thiéry

@jdemeyer
Copy link
Author

comment:9

Thanks!

It could be that something did not work with some earlier version...

@vbraun
Copy link
Member

vbraun commented May 21, 2016

Changed branch from u/jdemeyer/ticket/20633 to fae960a

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

3 participants