added docstring to logging.py and added pydocstyle to github workflow #158
Conversation
This file contains 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
apoorv-asc
approved these changes
Aug 6, 2024
refeed
requested changes
Aug 7, 2024
|
|
Hi @refeed made a commit, please check. |
refeed
requested changes
Aug 26, 2024
|
|
||
| Here, if `verbose` is set to ``True``,then all the log messages higher than DEBUG level will be displayed in `verbose` format. | ||
| But, if `verbose` is set to ``False``, all the log messages that are higher than INFO level i.e. ('INFO', 'WARNING', 'CRITICAL') will be dsiplayed in `normal` format. | ||
|
|
There was a problem hiding this comment.
Thanks for the detailed docstring! but I think it can be made shorter
I'd write it as the following:
Set up logging configuration.
:param verbose: If set to `True` will log all messages higher than DEBUG level, otherwise it will log the messages that are higher than INFO level ('INFO', 'WARNING', 'CRITICAL')
| to control the verbosity and formatting of log messages. The ``setup_logging`` function | ||
| allows switching between verbose and normal logging modes. | ||
|
|
||
| """ |
There was a problem hiding this comment.
We can remove the It provides a default logging configuration with different handlers and formatters to control the verbosity and formatting of log messages. The ``setup_logging`` function allows switching between verbose and normal logging modes. part
| @@ -38,6 +48,14 @@ | |||
|
|
|||
|
|
|||
| def setup_logging(verbose: bool = False): | |||
|
|
|||
refeed
reviewed
Aug 26, 2024
|
Merged this via #188 . Thanks for the contribution! |
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.
Hi, @refeed I have added a docstring to logging.py and also added pydocstyle to github workflow. Do checkout and let me know am i going right?