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

Improve typing coverage #175

Merged
merged 7 commits into from
Oct 7, 2020
Merged

Improve typing coverage #175

merged 7 commits into from
Oct 7, 2020

Conversation

araffin
Copy link
Member

@araffin araffin commented Oct 3, 2020

Description

Addresses part of #1

Done:

  • most VecEnv and wrappers

Missing:

  • Vec video recorder

Motivation and Context

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

closes #87

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

The remaining method without a return type are (2 because they are abstract method and one because pytype does not play nicely with it):

stable_baselines3/common/policies.py::BaseModel::forward
stable_baselines3/common/buffers.py::BaseBuffer::sample
stable_baselines3/common/save_util.py::open_path

@araffin araffin mentioned this pull request Oct 3, 2020
42 tasks
@Miffyli Miffyli mentioned this pull request Oct 4, 2020
13 tasks
@araffin araffin marked this pull request as ready for review October 4, 2020 15:39
@araffin araffin requested a review from Miffyli October 4, 2020 15:39
@Miffyli
Copy link
Collaborator

Miffyli commented Oct 5, 2020

Looked over the changes and they seem to check out, just a comment on if docstrings should be checked at the same time now that the same files being modified.

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.

If no other docstrings are about to be modified, LGTM!

@araffin
Copy link
Member Author

araffin commented Oct 7, 2020

If no other docstrings are about to be modified, LGTM!

At the end, it was not much so I did the changes. I also improved the error messages to address #180.

@araffin araffin merged commit a1e0556 into master Oct 7, 2020
@araffin araffin deleted the misc/more-typing branch October 7, 2020 08:51
leor-c pushed a commit to leor-c/stable-baselines3 that referenced this pull request Nov 12, 2020
* Improve typing coverage

* Even more types

* Fixes

* Update changelog

* Unified docstrings

* Improve error messages for unsupported spaces
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.

[Enhancement] Improve Typing Support / Ensure every function has return type
2 participants