Opened 5 years ago

Closed 5 years ago

#4222 defect closed fixed (fixed)

API docs for `twisted.internet.stdio.StandardIO` missing

Reported by: exarkun Owned by:
Priority: normal Milestone:
Component: core Keywords: documentation, easy
Cc: khorn Branch:
Author: Launchpad Bug:

Description

http://twistedmatrix.com/documents/9.0.0/api/twisted.internet.stdio.html isn't very helpful. If the module had an __all__ including 'StandardIO' things would probably be better.

Attachments (1)

stdio.patch (655 bytes) - added by exarkun 5 years ago.
It was really easy

Download all attachments as: .zip

Change History (6)

comment:1 Changed 5 years ago by khorn

  • Cc khorn added

Changed 5 years ago by exarkun

It was really easy

comment:2 Changed 5 years ago by exarkun

  • Keywords review added
  • Owner glyph deleted

comment:3 Changed 5 years ago by khorn

  • Keywords review removed
  • Owner set to exarkun

This looks fine to me.

comment:4 Changed 5 years ago by exarkun

  • Resolution set to fixed
  • Status changed from new to closed

(In [28077]) Apply stdio.patch to explicitly expose StandardIO in twisted.internet.stdio

Author: exarkun
Reviewer: khorn
Fixes: #4222

Add an __all__ to twisted.internet.stdio which includes StandardIO to make
it clear (to people and to automated tools) that StandardIO is the API that is
exported by this module.

comment:5 Changed 4 years ago by <automation>

  • Owner exarkun deleted
Note: See TracTickets for help on using tickets.