Bug 959446
| Summary: | Several mistyped connection options in the API documentation | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | Red Hat Enterprise MRG | Reporter: | Petr Matousek <pematous> | ||||||
| Component: | python-qpid | Assignee: | Ernie <eallen> | ||||||
| Status: | CLOSED ERRATA | QA Contact: | Messaging QE <messaging-qe-bugs> | ||||||
| Severity: | medium | Docs Contact: | |||||||
| Priority: | medium | ||||||||
| Version: | 2.3 | CC: | iboverma, jross, lzhaldyb | ||||||
| Target Milestone: | 3.0 | Keywords: | Patch | ||||||
| Target Release: | --- | ||||||||
| Hardware: | Unspecified | ||||||||
| OS: | Unspecified | ||||||||
| Whiteboard: | |||||||||
| Fixed In Version: | python-qpid-0.22-5 | Doc Type: | Bug Fix | ||||||
| Doc Text: | Story Points: | --- | |||||||
| Clone Of: | Environment: | ||||||||
| Last Closed: | 2014-09-24 15:07:55 UTC | Type: | Bug | ||||||
| Regression: | --- | Mount Type: | --- | ||||||
| Documentation: | --- | CRM: | |||||||
| Verified Versions: | Category: | --- | |||||||
| oVirt Team: | --- | RHEL 7.3 requirements from Atomic Host: | |||||||
| Cloudforms Team: | --- | Target Upstream Version: | |||||||
| Embargoed: | |||||||||
| Attachments: |
|
||||||||
|
Description
Petr Matousek
2013-05-03 13:57:20 UTC
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.
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()
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 |