-
Notifications
You must be signed in to change notification settings - Fork 52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Re-organize the consuming documentation for clarity #177
Conversation
I think it would have helped me today if we add an example of calling that example class via the CLI. i.e. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM!
docs/consuming.rst
Outdated
|
||
The callback provided to :func:`fedora_messaging.api.consume` or the command-line | ||
interface can be any callable Python object, so long as it accepts the message | ||
object as a single position argument. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
object as a single position argument. | |
object as a single positional argument. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed, thanks!
A number of users did not find the section on using a class as a callback. This attempts to re-organize the documentation around the consumer API to make it clearer. Signed-off-by: Jeremy Cline <jcline@redhat.com>
Codecov Report
@@ Coverage Diff @@
## master #177 +/- ##
======================================
Coverage 95.4% 95.4%
======================================
Files 14 14
Lines 1481 1481
Branches 198 198
======================================
Hits 1413 1413
Misses 51 51
Partials 17 17 Continue to review full report at Codecov.
|
I've added a note following the example class. |
👍 |
A number of users did not find the section on using a class as a
callback. This attempts to re-organize the documentation around the
consumer API to make it clearer.
@dustymabe, @bowlofeggs, it'd be great if you could skim this and let me know if it's clearer.