Description of problem: When user generates the messaging API documentation from source, following connection options are mistyped in the documentation: reconnect_internal_max reconnect_internal_min reconnect_internal correct options names are following: reconnect_interval_max reconnect_interval_min reconnect_interval (this option is already listed, so only removal of 'reconnect_internal' is needed) Following connection options are missing types or description: reconnect_interval: missing type (float) sasl_service: missing description sasl_min_ssf: missing both type and description sasl_max_ssf: missing both type and description Above mentioned options documentation comes from the following source: qpid/messaging/endpoints.py NOTE: I've also noticed related warnings by generating the doc using epydoc: # epydoc -v qpid.messaging +------------------------------------------------------------------------------------------------------------------------------------------------------- | File /usr/lib/python2.6/site-packages/qpid/messaging/endpoints.py, line 72, in qpid.messaging.endpoints.Connection.__init__ | Warning: @param for unknown parameter "host" | Warning: @param for unknown parameter "port" | Warning: @param for unknown parameter "transport" | Warning: @param for unknown parameter "heartbeat" | Warning: @param for unknown parameter "username" | Warning: @param for unknown parameter "password" | Warning: @param for unknown parameter "sasl_mechanisms" | Warning: @param for unknown parameter "sasl_service" | Warning: @param for unknown parameter "sasl_min_ssf" | Warning: @param for unknown parameter "sasl_max_ssf" | Warning: @param for unknown parameter "reconnect" | Warning: @param for unknown parameter "reconnect_timeout" | Warning: @param for unknown parameter "reconnect_internal_min" | Warning: @param for unknown parameter "reconnect_internal_max" | Warning: @param for unknown parameter "reconnect_interval" | Warning: @param for unknown parameter "reconnect_limit" | Warning: @param for unknown parameter "reconnect_urls" | Warning: @param for unknown parameter "address_ttl" | Warning: @param for unknown parameter "ssl_keyfile" | Warning: @param for unknown parameter "ssl_certfile" | Warning: @param for unknown parameter "ssl_trustfile" | Warning: @type for unknown parameter "reconnect_internal" Version-Release number of selected component (if applicable): python-qpid-0.18-4 How reproducible: 100% Steps to Reproduce: 1. generate qpid messaging python api documentation from source Actual results: Several mistyped connection options and missing info in the connection class reference Expected results: Proper description of connection options in the connection class reference Additional info:
Created attachment 759214 [details] Fixes mistyped connection options and adds missing descriptions The warnings are still present because the options are passed in a dict. The warnings appear to be benign.
http://svn.apache.org/r1496623
The content was fixed, but formatting is incorrect. The corrected options - sasl_service, sasl_min_ssf, sasl_max_ssf appears on one line and the formatting is not consistent with other options around. I've also noticed that the constructor provides wrong description: > "Creates a connection. A newly created connection must be connected with the Connection.connect() method before it can be used." I would expect Connection.open() method to be used instead of Connection.connect().
Created attachment 793784 [details] Fixes documentation problem Removes extraneous sasl_min/max/service text Fixes description of sasl_max_ssf to say "maximum" instead of "minimum" Changes constructor description to say open() instead of connect()
https://svn.apache.org/r1525570 https://issues.apache.org/jira/browse/QPID-5154 -> POST
content approved. package in test: python-qpid-0.22-8.el6 -> VERIFIED
Since the problem described in this bug report should be resolved in a recent advisory, it has been closed with a resolution of ERRATA. For information on the advisory, and where to find the updated files, follow the link below. If the solution does not work for you, open a new bug report. http://rhn.redhat.com/errata/RHEA-2014-1296.html