-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Cleanup docstring types #169
Conversation
Please wait a tiny bit before merging... I'm experimenting a better way to solve the style issue |
This reverts commit d091f43.
It is ready now ;) (I tested a js hack, that was kinda working but unsatisfying) |
Skimmed through results and looks good to me, apart from one derp-looking docstring :) |
Is this ready for checking/merging? Things look good but I wonder if there are still some docstrings missing :) |
ready for what it was meant for ;) |
finishing to type everything is another issue |
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.
In that case LGTM! Will take an internal note on cleaning up any remaining types in doctstrings / adding missing ones :)
Description
closes #10 (follow up of #167 )
I used some regex magic to do that ;) (see details in the issue).
I used some css to make the type prettier.
The result: https://stable-baselines3.readthedocs.io/en/doc-clean-types/modules/base.html
TODO:
Motivation and Context
Types of changes
Checklist:
make format
(required)make check-codestyle
andmake lint
(required)make pytest
andmake type
both pass. (required)Note: we are using a maximum length of 127 characters per line