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 missing names in @type docstring fields #9874

Closed
twisted-trac opened this issue Jun 26, 2020 · 3 comments
Closed

Add missing names in @type docstring fields #9874

twisted-trac opened this issue Jun 26, 2020 · 3 comments

Comments

@twisted-trac
Copy link

mthuurne's avatar @mthuurne reported
Trac ID trac#9874
Type defect
Created 2020-06-26 06:26:23Z

Some @type fields are missing the name of the variable they're describing the type of:

src/twisted/logger/_logger.py:29: Missing field name in @type
src/twisted/python/modules.py:56: Missing field name in @type
src/twisted/names/secondary.py:110: Missing field name in @type
src/twisted/names/secondary.py:113: Missing field name in @type

While pydoctor would warn about this, until now it did so at a low warning level that was silenced when Twisted produces its API docs.

Searchable metadata
trac-id__9874 9874
type__defect defect
reporter__mthuurne mthuurne
priority__normal normal
milestone__None None
branch__ 
branch_author__ 
status__closed closed
resolution__fixed fixed
component__core core
keywords__review review
time__1593152783900477 1593152783900477
changetime__1593302717760168 1593302717760168
version__None None
owner__Maarten_ter_Huurne__maarten_____ Maarten ter Huurne <maarten@...>

@twisted-trac
Copy link
Author

mthuurne's avatar @mthuurne set owner to @mthuurne
@mthuurne set status to assigned

PR is here: #1319

@twisted-trac
Copy link
Author

mthuurne's avatar @mthuurne removed owner
@mthuurne set status to new

@twisted-trac
Copy link
Author

mthuurne's avatar @mthuurne set owner to @mthuurne
@mthuurne set status to closed

In changeset fc3d899

#!CommitTicketReference repository="" revision="fc3d899fcdb66689c916bad8b649a83a14d6b872"
Merge pull request #1319 from twisted/9874-mthuurne-missing_docstring_field_names

Add missing docstring field names

Author: mthuurne
Reviewer: rodrigc
Fixes: ticket:9874

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

No branches or pull requests

1 participant