[tor-bugs] #9411 [Pluggable transport]: pyptlib.server.reportSuccess documentation misses required options parameter

["Tor Bug Tracker & Wiki" <blackhole@xxxxxxxxxxxxxx>]

#9411: pyptlib.server.reportSuccess documentation misses required options
parameter
---------------------------------+------------------------------------------
 Reporter:  dcf                  |          Owner:  asn
     Type:  defect               |         Status:  new
 Priority:  minor                |      Milestone:     
Component:  Pluggable transport  |        Version:     
 Keywords:  pyptlib              |         Parent:     
   Points:                       |   Actualpoints:     
---------------------------------+------------------------------------------
 https://pyptlib.readthedocs.org/en/master/API.html#report-results-back-to-
 tor has this example:
 {{{
 pyptlib.server.reportSuccess('rot13', ('127.0.0.1', 42042))
 }}}
 But this doesn't work, because of a required third `options` parameter:
 {{{
 TypeError: reportSuccess() takes exactly 3 arguments (2 given)
 }}}
 So `reportSuccess` should be documented to need `None` as a third argument
 if you don't need any options, or `options` should be made an optional
 parameter.

-- 
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/9411>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs