jldbc / jldbc/pybaseball

Function docstring standardization

Open
#125 8 comments 0 reactions 0 assignees View on GitHub
feedback wanted governance
Dominant language
Python
Stars
1.7k
Forks
428
PR merge metrics
No merged PRs in 30d

Description

It seems like we have a few different docstring styles in the code. I'd like to standardize around one format as a standard.

I found this article on some different standards/options:

https://stackoverflow.com/questions/3898572/what-is-the-standard-python-docstring-format

Of these I'm not picky, except to say I'm not super into the Epytext/Javadoc style. I do like the readability of numpydoc.

If we can decide on this, I'll take it on to port over existing docstrings.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.