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 type annotations to public API. Fix #172 #189

Merged
merged 1 commit into from
May 30, 2022
Merged

Conversation

thibaudcolas
Copy link
Member

@thibaudcolas thibaudcolas commented Jan 25, 2022

Description

Fixes #172. The public Python API is only made up of register_context_modifier, which is already typed correctly, and override_tag, which has a pretty simple signature.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • [ ] I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • [ ] I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have added an appropriate CHANGELOG entry

Suggested CHANGELOG entry:

### Added

- The package is now published with type hints for the public API (`register_context_modifier` and `override_tag`) ([#172](https://github.com/torchbox/django-pattern-library/issues/172), [#189](https://github.com/torchbox/django-pattern-library/pull/189)).

@thibaudcolas thibaudcolas added enhancement New feature or request django Related to Django templates capabilities status: Needs review labels Jan 25, 2022
@thibaudcolas thibaudcolas added this to the v1.0.0 milestone Jan 25, 2022
@thibaudcolas thibaudcolas merged commit 03030c5 into main May 30, 2022
@thibaudcolas thibaudcolas deleted the feature/172-typing branch May 30, 2022 16:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
django Related to Django templates capabilities enhancement New feature or request
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Add type hints for public API
2 participants