nolds icon indicating copy to clipboard operation
nolds copied to clipboard

Epic: Create docstring guidelines

Open CSchoel opened this issue 6 months ago • 0 comments

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

CSchoel avatar Jun 22 '25 09:06 CSchoel