Opened 6 years ago

Closed 6 years ago

#4677 defect closed fixed (fixed)

ITelnetTransport API documentation is incorrect for refusal case

Reported by: exarkun Owned by:
Priority: normal Milestone:
Component: conch Keywords: documentation
Cc: Branch: branches/telnet-transport-docs-4677-2
branch-diff, diff-cov, branch-cov, buildbot
Author: exarkun


The do and will methods claim that the Deferred will fire with False if the option is refused. In fact, in the only implementation, the do Deferred will fire with OptionRefused and the will Deferred will probably errback with an AssertionError because of #4231.

The docs should be updated to reflect the implementation (not the reverse, since people might actually have depended on the currently implemented behavior).

Change History (6)

comment:1 Changed 6 years ago by exarkun

  • Author set to exarkun
  • Branch set to branches/telnet-transport-docs-4677

(In [30111]) Branching to 'telnet-transport-docs-4677'

comment:2 Changed 6 years ago by exarkun

  • Branch changed from branches/telnet-transport-docs-4677 to branches/telnet-transport-docs-4677-2

(In [30119]) Branching to 'telnet-transport-docs-4677-2'

comment:3 Changed 6 years ago by exarkun

  • Keywords review added
  • Owner exarkun deleted

Simple doc changes in the branch, please review.

comment:4 Changed 6 years ago by therve

  • Keywords review removed
  • Owner set to exarkun

Looks good, please merge.

comment:5 Changed 6 years ago by exarkun

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

(In [30142]) Merge telnet-transport-docs-4677-2

Author: exarkun Reviewer: therve Fixes: #4677

Document a state tracking class internal to twisted.conch.telnet used for tracking the progress and results of telnet option negotiation. Also correct the interface documentation on ITelnetTransport to correctly describe the behavior in the case an option is refused.

comment:6 Changed 6 years ago by <automation>

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