nolds
nolds copied to clipboard
Epic: Create docstring guidelines
The docstrings in nolds are fairly consistent, but it wouldn't hurt to actually write down some conventions and make sure all docstrings adhere to them:
- [ ] Are args descriptions full sentences or not? (Capitalization of first word + dot at the end.)
- [ ] Should the first line in a function/method docstring be an imperative ("Calculate...") or not ("Calculates ...").
- [ ] https://github.com/CSchoel/nolds/issues/66