Ticket #4677 defect closed fixed

Opened 3 years ago

Last modified 3 years ago

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
Author: exarkun Launchpad Bug:

Description

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

1

Changed 3 years ago by exarkun

  • branch set to branches/telnet-transport-docs-4677
  • branch_author set to exarkun

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

2

Changed 3 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'

3

Changed 3 years ago by exarkun

  • owner exarkun deleted
  • keywords review added

Simple doc changes in the branch, please review.

4

Changed 3 years ago by therve

  • keywords review removed
  • owner set to exarkun

Looks good, please merge.

5

Changed 3 years ago by exarkun

  • status changed from new to closed
  • resolution set to fixed

(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.

6

Changed 2 years ago by <automation>

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