Skip to content

Add basic type annotations & docstrings to arcade.hitbox.base #1777

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 11 commits into from
May 18, 2023
Merged

Add basic type annotations & docstrings to arcade.hitbox.base #1777

merged 11 commits into from
May 18, 2023

Conversation

@pushfoo
Copy link
Member

@pushfoo pushfoo commented May 16, 2023 •
edited
Loading

Changes

  • Add missing annotations to arcade.hitbox.base members
  • Add basic docstrings to arcade.hitbox.base members
  • Add protected top-level workaround constant
  • Add notes on why we don't cache axis extrema properties

Why

  • IDE tooltips & hints
  • Help anyone who reads the source

How to test

  1. Run linting & unit tests as normal
  2. Check IDE type annotation / docstring rendering for HitBox classes

Questions for reviewers

  • Is our rotation direction consistent enough that I can add it here / to the programming guide?
  • Should I update update_quick_index.py to generate this doc now?

cspotcode
cspotcode reviewed May 17, 2023
View reviewed changes
@pvcraven pvcraven merged commit 854f16f into pythonarcade:development May 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cspotcode cspotcode cspotcode left review comments

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@pushfoo @cspotcode @pvcraven