Skip to content

Conversation

@bamblebam
Copy link
Contributor

@bamblebam bamblebam commented Aug 25, 2021

What does this PR do?

Fixes #9028
Adds docstrings to the CSV logger class.

Does your PR introduce any breaking changes? If yes, please list them.

None

Before submitting

  • Was this discussed/approved via a GitHub issue? (not for typos and docs)
  • Did you read the contributor guideline, Pull Request section?
  • Did you make sure your PR does only one thing, instead of bundling different changes together?
  • Did you make sure to update the documentation with your changes? (if necessary)
  • Did you write any new necessary tests? (not for typos and docs)
  • Did you verify new and existing tests pass locally with your changes?
  • Did you list all the breaking changes introduced by this pull request?
  • Did you update the CHANGELOG? (not for typos, docs, test updates, or internal minor changes/refactorings)

PR review

Anyone in the community is welcome to review the PR.
Before you start reviewing make sure you have read Review guidelines. In short, see the following bullet-list:

  • Is this pull request ready for review? (if not, please submit in draft mode)
  • Check that all items from Before submitting are resolved
  • Make sure the title is self-explanatory and the description concisely explains the PR
  • Add labels and milestones (and optionally projects) to the PR so it can be classified

Did you have fun?

Make sure you had fun coding 🙃

@awaelchli awaelchli added docs Documentation related logger Related to the Loggers labels Aug 25, 2021
@awaelchli awaelchli added this to the v1.5 milestone Aug 25, 2021
@codecov
Copy link

codecov bot commented Aug 26, 2021

Codecov Report

Merging #9112 (b48422b) into master (1a2468f) will decrease coverage by 4%.
The diff coverage is n/a.

❗ Current head b48422b differs from pull request most recent head b08b94e. Consider uploading reports for the commit b08b94e to get more accurate results

@@           Coverage Diff           @@
##           master   #9112    +/-   ##
=======================================
- Coverage      92%     88%    -4%     
=======================================
  Files         178     175     -3     
  Lines       14694   14665    -29     
=======================================
- Hits        13526   12888   -638     
- Misses       1168    1777   +609     

Copy link
Contributor

@tchaton tchaton left a comment

Choose a reason for hiding this comment

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

LGTM !

@mergify mergify bot added the ready PRs ready to be merged label Aug 26, 2021
@mergify mergify bot requested a review from a team August 26, 2021 08:58
@awaelchli awaelchli enabled auto-merge (squash) August 27, 2021 08:49
@awaelchli awaelchli merged commit ccc83e7 into Lightning-AI:master Sep 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation related logger Related to the Loggers ready PRs ready to be merged

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add missing docstrings to public properties in loggers

6 participants