Opened 12 years ago

Closed 12 years ago

#1919 defect closed fixed (fixed)

Watering the twisted.web2 docstring desert

Reported by: edsuom Owned by:
Priority: normal Milestone:
Component: web2 Keywords:
Cc: Branch:


twisted.web2.client.http is devoid of docstrings. There are probably other equally important twisted.web2 modules that need docstring TLC, too.

Change History (7)

comment:1 Changed 12 years ago by David Reid

Keywords: review added

I've written docstrings for web2 client, vhost, some things in http and some things in http_headers. The focus is on user APIs.

More doc strings could be written but I'd like to go ahead and merge and close this bug so it doesn't get stagnant.

branched to source:branches/web2-docstring-1919

comment:2 Changed 12 years ago by David Reid

Owner: David Reid deleted

comment:3 Changed 12 years ago by Cory Dodt

Keywords: review removed
Owner: set to David Reid

These all read fine. Fixed a few typos, that's about it.

comment:4 Changed 12 years ago by Cory Dodt

Crap, should have actually run the tests. "no module named interfaces" ... I will fix, don't check in yet.

comment:5 Changed 12 years ago by Cory Dodt

OK, tests pass in r17451.

comment:6 Changed 12 years ago by David Reid

Resolution: fixed
Status: newclosed

(In [17544]) Docstrings for various userfacing methods and classes.

This also contains a few extra lines for readability sake.

Reviewer: MFen Author: dreid Fixes #1919

comment:7 Changed 7 years ago by <automation>

Owner: David Reid deleted
Note: See TracTickets for help on using tickets.