Skip to content

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

Merged
merged 35 commits into from
Jan 10, 2022
Merged

Add logging guideline section. #23

merged 35 commits into from
Jan 10, 2022

Conversation

MaxJPRey
Copy link
Contributor

Add logging guideline section.

@MaxJPRey MaxJPRey requested a review from akaszynski December 30, 2021 19:30
@MaxJPRey MaxJPRey marked this pull request as draft December 30, 2021 19:32
@MaxJPRey MaxJPRey marked this pull request as ready for review December 30, 2021 19:34
@MaxJPRey MaxJPRey marked this pull request as draft December 30, 2021 19:37
@MaxJPRey MaxJPRey marked this pull request as ready for review December 30, 2021 19:39
@akaszynski
Copy link
Contributor

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.

@MaxJPRey
Copy link
Contributor Author

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
Copy link
Contributor Author

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
Copy link
Contributor Author

@MaxJPRey MaxJPRey Jan 3, 2022

Choose a reason for hiding this comment

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

@akaszynski

Suggested change
logger : logging.Logger or logging.Logger
logger : logging.Logger or pyansys_logging.Logger


Parameters
----------
logger : logging.Logger or logging.Logger
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@akaszynski

Suggested change
logger : logging.Logger or logging.Logger
logger : logging.Logger or pyansys_logging.Logger

Copy link
Contributor

@akaszynski akaszynski left a 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.

@akaszynski akaszynski merged commit c62ea54 into main Jan 10, 2022
@akaszynski akaszynski deleted the feat/logging_guideline branch January 10, 2022 15:31
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.

2 participants