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

fix(traceback): fix type-hints for locals_max_{length|string} #3630

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

ruancomelli
Copy link

Type of changes

  • Bug fix
  • New feature
  • Documentation / docstrings
  • Tests
  • Other

Checklist

  • I've run the latest black with default args on new code.
  • I've updated CHANGELOG.md and CONTRIBUTORS.md where appropriate.
  • I've added tests for new code.
  • I accept that @willmcgugan may be pedantic in the code review.

Description

The documentation of parameters locals_max_length and locals_max_string states that they can be None, in which case no maximum is applied:

locals_max_length (int, optional): Maximum length of containers before abbreviating, or None for no abbreviation. Defaults to 10.
locals_max_string (int, optional): Maximum length of string before truncating, or None to disable. Defaults to 80.

This PR fixes the corresponding type-hints to allow None by replacing int with Optional[int].

The documentation of parameters `locals_max_length`
and `locals_max_string` states that they can be
`None`, in which case no maximum is applied.
This commit fixes the corresponding type-hints
to allow `None` by replacing `int` with
`Optional[int]`.
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.

1 participant