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 documentation of non-existing parameters #10059

Closed
twisted-trac opened this issue Nov 27, 2020 · 2 comments
Closed

Fix documentation of non-existing parameters #10059

twisted-trac opened this issue Nov 27, 2020 · 2 comments

Comments

@twisted-trac
Copy link

mthuurne's avatar @mthuurne reported
Trac ID trac#10059
Type defect
Created 2020-11-27 14:06:05Z

I made pydoctor a bit stricter again and as usual this makes it issue a bunch of warnings when processing the Twisted code:

src/twisted/application/internet.py:589: Documented parameter "_awaitingConnected" does not exist
src/twisted/conch/ssh/userauth.py:695: Documented parameter "publicKey" does not exist
src/twisted/internet/_dumbwin32proc.py:287: Documented parameter "data" does not exist
src/twisted/internet/_newtls.py:109: Documented parameter "param" does not exist
src/twisted/internet/udp.py:145: Documented parameter "proto" does not exist
src/twisted/mail/relaymanager.py:248: Documented parameter "pKwArgs" does not exist
src/twisted/mail/smtp.py:2140: Documented parameter "to_addr" does not exist
src/twisted/names/authority.py:435: Documented parameter "rdate" does not exist
src/twisted/plugins/cred_unix.py:102: Documented parameter "pwd" does not exist
src/twisted/protocols/haproxy/_parser.py:30: Documented parameter "arguments" does not exist
src/twisted/python/util.py:849: Documented parameter "uid" does not exist
src/twisted/python/util.py:871: Documented parameter "uid" does not exist
src/twisted/trial/itrial.py:114: Documented parameter "error" does not exist
src/twisted/web/http.py:1365: Documented parameter "k" does not exist
src/twisted/web/http.py:1368: Documented parameter "v" does not exist
src/twisted/web/http.py:2487: Documented parameter "data" does not exist
src/twisted/web/iweb.py:416: Documented parameter "peer" does not exist
src/twisted/words/service.py:706: Documented parameter "channel" does not exist
Searchable metadata
trac-id__10059 10059
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__1606485965907921 1606485965907921
changetime__1606493833850125 1606493833850125
version__None None
owner__Maarten_ter_Huurne__maarten_____ Maarten ter Huurne <maarten@...>

@twisted-trac
Copy link
Author

mthuurne's avatar @mthuurne commented

PR is ready for review: #1485

@twisted-trac
Copy link
Author

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

In changeset cc71bf5

#!CommitTicketReference repository="" revision="cc71bf5a0ef6b2a4b7788b113ff0ffa078f22a6f"
Merge pull request #1485 from twisted/10059-nonexisting-params-in-docstrings

Author: mthuurne
Reviewer: adiroiban
Fixes: ticket:10059

Fix documentation of non-existing parameters

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