Normalize docstring style
Description
Normalize muttlib
docstring style with numpydoc.
Motivation
- Give users an unified look and feel when reading
muttlib
docs, - Provide a simple docstring guideline to contributors.
Proposal
- Use pyment to automatically: (80/20)
- transform actual google-style docstring to numpydoc,
- generate or complete missing docstring.
- Fine-tuning fixing due possible
pyment
margin of error: (20/80)
Drawbacks
- Potential workload due fine-tuning,
-
numpydoc
not being the right choice,
Alternatives
- Evaluate another docstring style.
- Do nothing.
Notes
More on napoleon
– Sphinx's Support for NumPy and Google style docstrings
Edited by Luis Alberto Hernandez