Consistent code formatting & docstrings

[k-sys]

No description provided.

[michaelosthege]

Wherever I write something, I add typing annotations and numpy-style docstrings.

Eventually, we could use black-formatting.

[k-sys]

I've been enjoying black and think we should use that going forward. I didn't realize numpy had a style but that's a great resource doc thank you for sharing.

I assume doc strings we can update over time – for black formatting, what is the best way to make this happen other than fyi to contributors?

[michaelosthege]

In PyMC3 we decided to black only the files that are touched by a PR:

• keeps line history more intact
• reduces git conflicts in ongoing PRs

That and docstring style should go into CONTRIBUTING.md and PR template (#11)

[mikeyk]

FWIW, for the covid-dash we use “prettier” (kind of like black but for javascript) and did 1) a one-time fixup of every file 2) add a git pre-commit hook (easier in JS because you can set one in package.json)

…

On Sun, Jul 5 2020 at 8:29 PM, Michael Osthege < ***@***.*** > wrote: In PyMC3 we decided to black only the files that are touched by a PR: * keeps line history more intact * reduces git conflicts in ongoing PRs That and docstring style should go into CONTRIBUTING.md and PR template ( #11 ( #11 ) ) — You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub ( #12 (comment) ) , or unsubscribe ( https://github.com/notifications/unsubscribe-auth/AAAFF4LP676CRGEZLDFLZGTR2FALJANCNFSM4OPOTWDA ).