Skip to content

Contributor Doc Updates#42

Merged
kwzrd merged 7 commits into
masterfrom
update-logging-levels
Mar 19, 2020
Merged

Contributor Doc Updates#42
kwzrd merged 7 commits into
masterfrom
update-logging-levels

Conversation

@sco1
Copy link
Copy Markdown
Contributor

@sco1 sco1 commented Mar 18, 2020

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

Copy link
Copy Markdown
Contributor

@lemonsaurus lemonsaurus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@sco1 sco1 marked this pull request as ready for review March 19, 2020 17:04
Copy link
Copy Markdown
Contributor

@kwzrd kwzrd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@kwzrd kwzrd merged commit 462f188 into master Mar 19, 2020
@kwzrd kwzrd deleted the update-logging-levels branch March 19, 2020 19:20
Comment thread CONTRIBUTING.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants