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

Adds hinting for list objects to the add method #35

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

Conversation

mlissner
Copy link
Contributor

This change makes it so that the method docstring supports either lists or dicts. I ran into this issue when Intellij was unhappy because I was passing a list to the add method instead of a dict, as the method requested.

This fixes the linting issue in my IDE, and apparently, there's no standard on this (yet), so it should be a decent way to proceed. Here's the documentation for Intellij and PyCharm, where they describe the syntax that they prefer (they're usually pretty sane about these things):

https://www.jetbrains.com/help/pycharm/2016.1/type-hinting-in-pycharm.html#legacy

@coveralls
Copy link

coveralls commented Sep 12, 2016

Coverage Status

Coverage remained the same at 95.369% when pulling d0c720e on mlissner:patch-1 into 6075730 on lugensa:master.

@mlissner
Copy link
Contributor Author

mlissner commented Oct 5, 2020

This is a very small tweak to the type hints that should be ready to land.

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.

2 participants