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 hints to content_tagging code in edx-platform #102

Closed
bradenmacdonald opened this issue Sep 15, 2023 · 1 comment
Closed

Add type hints to content_tagging code in edx-platform #102

bradenmacdonald opened this issue Sep 15, 2023 · 1 comment

Comments

@bradenmacdonald
Copy link
Contributor

Story: "As a developer, I want the content tagging code to have type hints so that it's more self-documenting and has fewer bugs"

Details:

  1. Enforce typing and linting for the content_tagging app in edx-platform: https://github.com/openedx/edx-platform/tree/c75c706c6f6f4d46a06b6c98041f9a95ccf0ff3d/openedx/features/content_tagging

Criteria:

  1. content_tagging is included in the mypy checks that run during CI tests
  2. Add type hints to every function in the content_tagging app in edx-platform, including the tests (adding -> None as the return type is necessary if there are no other type hints in the parameter or return type, because otherwise mypy won't check the code in that function)
@pkulkark
Copy link

Here's the PR with the fix: openedx/edx-platform#33484

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

2 participants