Contributor Doc Updates#42
Conversation
Since the dev channel is no longer role locked this statement isn't relevant
lemonsaurus
left a comment
There was a problem hiding this comment.
Yeah, these are excellent. This encapsulates perfectly the discussion we had on this topic, and is well-written besides. Also, the other changes here unrelated to log levels are necessary, and well executed.
Nice work.
kwzrd
left a comment
There was a problem hiding this comment.
I find this very well written, informative and easy to digest.
One thing that I noticed going over the doc is that the type annotation examples are out of sync with prevailing style in our repositories. Here, we'd prefer that input_2 is annotated using typing.Dict with the key, value types also specified:
def foo(input_1: int, input_2: dict) -> bool:The example just below lacks whitespace around the =, which is anti-PEP8 and will raise E252 using our lint configuration.
def foo(bar: int, baz: dict=None) -> bool:Should we perhaps adjust these while we're at it?
For review prior to pushing to individual projects, updated verbiage related to our logging levels.
See: https://github.com/python-discord/organisation/issues/222 for additional information