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.

Sign up for GitHub

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

Jump to bottom

Docstrings should use Napoleon syntax #27

Closed
EliAndrewC opened this issue Mar 24, 2014 · 3 comments
Closed

Docstrings should use Napoleon syntax #27

EliAndrewC opened this issue Mar 24, 2014 · 3 comments

Comments

@EliAndrewC
Copy link
Owner

We have a lot of docstrings for things in sideboard.lib, and I really like the formatting examples for https://pypi.python.org/pypi/sphinxcontrib-napoleon so I think we should start using that.

Rob Ruana will like this, since that's his project :)
@robdennis
Copy link
Contributor

Make this say sideboard

On Mon, Mar 24, 2014 at 7:05 PM, Eli Courtwright [email protected]
wrote:

We have a lot of docstrings for things in dradis.lib, and I really like the formatting examples for https://pypi.python.org/pypi/sphinxcontrib-napoleon so I think we should start using that.

Rob Ruana will like this, since that's his project :)

Reply to this email directly or view it on GitHub:
#27

@EliAndrewC
Copy link
Owner Author

Good catch, thanks, don't want to confuse anyone.

@EliAndrewC
Copy link
Owner Author

Moved to magfest/sideboard#37

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@robdennis @EliAndrewC