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

Cleanup docstring types #169

Merged
merged 7 commits into from
Oct 2, 2020
Merged

Cleanup docstring types #169

merged 7 commits into from
Oct 2, 2020

Conversation

araffin
Copy link
Member

@araffin araffin commented Sep 30, 2020

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

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)

Checklist:

  • I've read the CONTRIBUTION guide (required)
  • I have updated the changelog accordingly (required).
  • My change requires a change to the documentation.
  • I have updated the tests accordingly (required for a bug fix or a new feature).
  • I have updated the documentation accordingly.
  • I have reformatted the code using make format (required)
  • I have checked the codestyle using make check-codestyle and make lint (required)
  • I have ensured make pytest and make type both pass. (required)

Note: we are using a maximum length of 127 characters per line

@araffin araffin requested review from Miffyli, AdamGleave, ernestum and hill-a and removed request for Miffyli September 30, 2020 15:01
@araffin
Copy link
Member Author

araffin commented Sep 30, 2020

Please wait a tiny bit before merging... I'm experimenting a better way to solve the style issue

@araffin
Copy link
Member Author

araffin commented Sep 30, 2020

It is ready now ;) (I tested a js hack, that was kinda working but unsatisfying)
I also trying playing with sphinx extension but could not manage to change the formatting without breaking the build.

@Miffyli
Copy link
Collaborator

Miffyli commented Sep 30, 2020

Skimmed through results and looks good to me, apart from one derp-looking docstring :)

@Miffyli
Copy link
Collaborator

Miffyli commented Oct 2, 2020

Is this ready for checking/merging? Things look good but I wonder if there are still some docstrings missing :)

@araffin
Copy link
Member Author

araffin commented Oct 2, 2020

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 ;)

@araffin
Copy link
Member Author

araffin commented Oct 2, 2020

finishing to type everything is another issue

Copy link
Collaborator

@Miffyli Miffyli left a 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 :)

@Miffyli Miffyli merged commit 5591257 into master Oct 2, 2020
@Miffyli Miffyli deleted the doc/clean-types branch October 2, 2020 17:06
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.

Custom parser for type hints
2 participants