Opened 4 years ago

Closed 4 years ago

#6666 enhancement closed fixed (fixed)

pop3.py should conform to docstring and whitespace standards

Reported by: Stacey Sern Owned by: lvh
Priority: normal Milestone:
Component: mail Keywords: documentation
Cc: Branch: branches/pop3-doc-6666
branch-diff, diff-cov, branch-cov, buildbot
Author: shira

Description

The docstrings in pop3.py should be updated to provide descriptions of all classes, functions and methods as well as their parameters and attributes. The spacing before classes and functions should conform to the coding standards.

Change History (7)

comment:1 Changed 4 years ago by Stacey Sern

Author: shira
Branch: branches/pop3-doc-6666

(In [39473]) Branching to 'pop3-doc-6666'

comment:2 Changed 4 years ago by Stacey Sern

(In [40042]) Revise docstrings and fix whitespace

refs #6666

comment:3 Changed 4 years ago by Stacey Sern

(In [40054]) Fixed twistedchecker errors

refs #6666

comment:4 Changed 4 years ago by Stacey Sern

Keywords: review added
Owner: Stacey Sern deleted

This builds with twistedchecker error 9016 on line 1366 due to a bug in twistedchecker (bug report #1217379).

comment:5 Changed 4 years ago by lvh

Owner: set to lvh

comment:6 Changed 4 years ago by lvh

Keywords: review removed

LGTM! Buildbot failure is there as you noted, but since that's a filed bug, I guess this can go in. I'll merge it for you :)

comment:7 Changed 4 years ago by lvh

Resolution: fixed
Status: newclosed

(In [40546]) Merge pop3-doc-6666: Full API documentation for twisted.mail.pop3

Author: shira Reviewer: lvh Fixes: #6666

The POP3 support was previously missing a lot of API documentation. This adds full API documentation for twisted.mail.pop3.

Note: See TracTickets for help on using tickets.