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 incorrect fields in docstrings #10021

Closed
twisted-trac opened this issue Oct 16, 2020 · 4 comments
Closed

Fix incorrect fields in docstrings #10021

twisted-trac opened this issue Oct 16, 2020 · 4 comments

Comments

@twisted-trac
Copy link

mthuurne's avatar @mthuurne reported
Trac ID trac#10021
Type defect
Created 2020-10-16 02:00:56Z

I added a bunch of additional warnings to pydoctor that flag incorrect usage of @param, @type, @return, @rtype and @raise fields in docstrings. As would be expected of a code base this large, there are now a few dozen warnings issued when generating Twisted's API docs. This ticket is for fixing those.

Searchable metadata
trac-id__10021 10021
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__None None
time__1602813656113442 1602813656113442
changetime__1603269453817512 1603269453817512
version__None None
owner__Maarten_ter_Huurne__maarten_____ Maarten ter Huurne <maarten@...>

@twisted-trac
Copy link
Author

mthuurne's avatar @mthuurne commented

PR is here: #1453

@twisted-trac
Copy link
Author

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

@twisted-trac
Copy link
Author

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

Approved with minor changes: #1453 (review)

@twisted-trac
Copy link
Author

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

In changeset 720f59d

#!CommitTicketReference repository="" revision="720f59dc970d8a32fdf9f97d1dc69855a04646e4"
Merge pull request #1453 from twisted/10021-mthuurne-fix-docstrings

Author: mthuurne
Reviewer: twm
Fixes: ticket:10021

Fix incorrect fields in docstrings

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