-
Notifications
You must be signed in to change notification settings - Fork 22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Suggestion: Include motivation in README.md. #15
Comments
It seems that the original motivation was explained in #5 but i agree that it will be nice have it in the README. Also, i don't understand the example in the README. Afaik >>> import logging
>>> logging.error("Hello {world}", extra={"world":"Earth", "color": "blue"})
ERROR:root:Hello {world}
>>> import logging
>>> logging.basicConfig(format="%(color)s - %(message)s")
>>> logging.error("Hello {world}", extra={"world":"Earth", "color": "blue"})
blue - Hello {world} |
@fpuga that is correct. I agree the README could be made clearer there. |
Thanks @afallou, it's more clear now. |
Since it is clear now that |
Has caused confusion. Just spent half an hour trying to figure out why the variables weren't being output. |
The README.md currently says:
However, if doesn't explain why this rigor is important. It is easy to dismiss this: "A foolish consistency is the hobgoblin of little minds."
I would add a few paragraphs explaining why this practice should be adopted.
e.g.
The text was updated successfully, but these errors were encountered: