Added doc strings for Comet logger

[bamblebam]

What does this PR do?

Links #9028
Add doc strings to the comet 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 🙃

[bamblebam]

I don't know if the docs for the version property are correct. Let me know if it isn't.

[codecov]

Codecov Report

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

@@           Coverage Diff           @@
##           master   #9114    +/-   ##
=======================================
- Coverage      92%     88%    -4%     
=======================================
  Files         178     176     -2     
  Lines       14694   14744    +50     
=======================================
- Hits        13526   12944   -582     
- Misses       1168    1800   +632     

[tchaton]

Thanks a lot for your contribution !