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 duplicate parameter documentation #10060

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

Fix duplicate parameter documentation #10060

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

Comments

@twisted-trac
Copy link

mthuurne's avatar @mthuurne reported
Trac ID trac#10060
Type defect
Created 2020-11-27 16:12:02Z

This is another cleanup as a result of pydoctor gaining a warning, this time about the same parameter being documented more than once.

There were three categories of mistakes found by this warning:

  • actual duplicate documentation for the same parameter
  • non-duplicate documentation accidentally using the name of another parameter
  • fields where @type was intended instead of @param
Searchable metadata
trac-id__10060 10060
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__1606493522772796 1606493522772796
changetime__1606496829247262 1606496829247262
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: #1486

@twisted-trac
Copy link
Author

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

In changeset aeb4529

#!CommitTicketReference repository="" revision="aeb4529d9fedd85b8743601bc05612acefd4ac03"
Merge pull request #1486 from twisted/10060-duplicate-param-docs

Author: mthuurne
Reviewer: adiroiban
Fixes: ticket:10060

Fix duplicate parameter documentation

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