Skip to content

Pycharm is confused by 'type' in docstrings #21622

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
Closed
aberres opened this issue Jun 25, 2018 · 0 comments · Fixed by #21623
Closed

Pycharm is confused by 'type' in docstrings #21622

aberres opened this issue Jun 25, 2018 · 0 comments · Fixed by #21623
Labels
Docs
Milestone
0.24.0

Comments

@aberres
Copy link
Contributor

aberres commented Jun 25, 2018 •
edited
Loading

Problem description

In quite some places the return type of functions is specified like this:

Returns
-------
swapped : type of caller (new object)

Pycharm now thinks the function returns an object of type type and warns about legitimate usage.

See #17079 for a related issue.

The problem could be mitigated by a wording avoiding any actual type as the first word.
Proposal how the change could look like: #21623
aberres added a commit to aberres/pandas that referenced this issue Jun 25, 2018
@aberres
DOC: Do no use 'type' as fist word when specifying a return type (pan…
7214e63 
…das-dev#21622)

Pycharm is otherwise confused and expects objects of type
'type' to be returned.
aberres added a commit to aberres/pandas that referenced this issue Jun 25, 2018
@aberres
DOC: Do no use 'type' as first word when specifying a return type (pa…
452cd99 
…ndas-dev#21622)

Pycharm is otherwise confused and expects objects of type
'type' to be returned.
@aberres aberres mentioned this issue Jun 25, 2018
Merged
4 tasks
@WillAyd WillAyd added the Docs label Jun 25, 2018
@jreback jreback added this to the 0.24.0 milestone Jun 25, 2018
jreback pushed a commit that referenced this issue Jun 25, 2018
@aberres @jreback
DOC: Do no use 'type' as first word when specifying a return type (#2…
3433f19 
…1622) (#21623)
Sup3rGeo pushed a commit to Sup3rGeo/pandas that referenced this issue Oct 1, 2018
@aberres
DOC: Do no use 'type' as first word when specifying a return type (pa…
9432e3c 
…ndas-dev#21622) (pandas-dev#21623)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Docs
Projects
None yet
Milestone
0.24.0
Development

Successfully merging a pull request may close this issue.

DOC: Do no use 'type' as first word when specifying a return type (#21622) aberres/pandas
3 participants
@WillAyd @jreback @aberres