Opened 11 years ago

Closed 11 years ago

#3689 defect closed fixed (fixed)

Valid values for type parameter to twisted.conch.ssh.keys.Key.toString can't be determined except by inspecting private implementation details

Reported by: Jean-Paul Calderone Owned by:
Priority: normal Milestone:
Component: conch Keywords: documentation
Cc: Branch: branches/tostring-docs-3689
branch-diff, diff-cov, branch-cov, buildbot
Author: exarkun


Key.toString accepts 'OPENSSH', 'LSH', or 'AGENTV3'. There's no way to find this out, though, except by looking up the _toString_* helper methods. The docstring for Key.toString should spell out possible values.

Change History (6)

comment:1 Changed 11 years ago by Jean-Paul Calderone

Author: exarkun
Branch: branches/tostring-docs-3689

(In [26371]) Branching to 'tostring-docs-3689'

comment:2 Changed 11 years ago by Jean-Paul Calderone

(In [26372]) expand Key.toString docs

refs #3689

comment:3 Changed 11 years ago by Jean-Paul Calderone

Keywords: review added
Owner: z3p deleted

comment:4 Changed 11 years ago by Glyph

Keywords: review removed
Owner: set to Jean-Paul Calderone

Looks good to me. Merge away.

comment:5 Changed 11 years ago by Jean-Paul Calderone

Resolution: fixed
Status: newclosed

(In [26481]) Merge tostring-docs-3689

Author: exarkun Reviewer: glyph Fixes: #3689

Improve the docstring for twisted.conch.ssh.keys.Key.toString, primarily by including the supported values of the type parameter.

comment:6 Changed 9 years ago by <automation>

Owner: Jean-Paul Calderone deleted
Note: See TracTickets for help on using tickets.