Cut the cookies, added the code, and deleted the todos #1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kattni
suggested changes
Mar 8, 2019
adafruit_logger.py
Outdated
| __version__ = "0.0.0-auto.0" | ||
| __repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_Logger.git" | ||
|
|
||
| import time |
There was a problem hiding this comment.
Please place this import on line 45 and delete the # imports comment.
adafruit_logger.py
Outdated
|
|
||
| @property | ||
| def level(self): | ||
| """Get the level.""" |
There was a problem hiding this comment.
You can simply docstring this as The level.. We try to stay away from using "Get" and "Set".
adafruit_logger.py
Outdated
|
|
||
| @level.setter | ||
| def level(self, value): | ||
| """Set the level.""" |
There was a problem hiding this comment.
setters do not need to be docstringed. You can remove this.
adafruit_logger.py
Outdated
|
|
||
| def log(self, level, format_string, *args): | ||
| """Log a message. | ||
| level -- the priority level at which to log |
There was a problem hiding this comment.
Please use :param level: The priority level at which to log formatting for documenting keywords. Include whitespace above the first :param and below the last :param, but it is not necessary between :params.
e.g.
"""Log a message.
:param level: The priority of the level at which to log.
:param format_string: the core message string with embedded formatting directives
:param args: arguments ``format_string.format()``, can be empty
"""
adafruit_logger.py
Outdated
| def log(self, level, format_string, *args): | ||
| """Log a message. | ||
| level -- the priority level at which to log | ||
| format_string -- the core mesage string with embedded formatting directives |
|
There is an example in the Readme, that uses the UartHandler, but that is not in the code yet, correct, or am I totally missing something.... very possible |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.