-
Notifications
You must be signed in to change notification settings - Fork 8
Add logging guideline section. #23
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
Conversation
This still needs more work. @MaxJPRey, can you add general logging guidelines at the top of this section? We explain how, but not why we log. I think adding several best practices would be helpful. |
@akaszynski I just added a "Why and when to log" section. |
|
||
Parameters | ||
---------- | ||
logger : logging.Logger or logging.Logger |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@akaszynski I am assuming that you were thinking about the Logger class above.
|
||
Parameters | ||
---------- | ||
logger : logging.Logger or logging.Logger |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logger : logging.Logger or logging.Logger | |
logger : logging.Logger or pyansys_logging.Logger |
|
||
Parameters | ||
---------- | ||
logger : logging.Logger or logging.Logger |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
logger : logging.Logger or logging.Logger | |
logger : logging.Logger or pyansys_logging.Logger |
… into feat/logging_guideline
…ev-guide into feat/logging_guideline
Co-authored-by: Alex Kaszynski <[email protected]>
Co-authored-by: Alex Kaszynski <[email protected]>
Co-authored-by: Alex Kaszynski <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is good for now. We're going to need another pass at reviewing the logging section, but better not to have this PR sitting around.
Add logging guideline section.