Skip to content
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

add missing docstrings to public properties in loggers #9028

Closed
awaelchli opened this issue Aug 21, 2021 · 5 comments · Fixed by #9030 or #9112
Closed

add missing docstrings to public properties in loggers #9028

awaelchli opened this issue Aug 21, 2021 · 5 comments · Fixed by #9030 or #9112
Labels
docs Documentation related good first issue Good for newcomers

Comments

@awaelchli
Copy link
Contributor

awaelchli commented Aug 21, 2021

📚 Documentation

There are a few undocumented public properties in the logger wrappers.
Example:
https://github.com/PyTorchLightning/pytorch-lightning/blob/92e49795e1e044ee7f1ca450babf0c50c1b5d81f/pytorch_lightning/loggers/mlflow.py#L174

Let's document these so they show up in our HTML docs and so users can discover them.

This is a good issue for new contributors!! If you are interested, please send a pull request right away (one per logger class).

@awaelchli awaelchli added good first issue Good for newcomers docs Documentation related help wanted Open to be worked on and removed help wanted Open to be worked on labels Aug 21, 2021
@bamblebam
Copy link
Contributor

I can do this

@bamblebam
Copy link
Contributor

I think this should still be open as the other logger classes are left.

@awaelchli awaelchli reopened this Aug 23, 2021
@awaelchli
Copy link
Contributor Author

@bamblebam it was auto-closed. It was because you had "Fixes xyz" in the description of the PR, GitHub was smart about it to close after merge :)

@bamblebam
Copy link
Contributor

Since the doc strings in other logger classes have been updated is this issue done or do we need to update the base logger class as well.

@awaelchli
Copy link
Contributor Author

Thanks a lot.
Feel free to update the base too if you see anything important missing, but I think most of it is covered :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related good first issue Good for newcomers
Projects
None yet
2 participants