Skip to content
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

Merged
merged 1 commit into from
May 21, 2019

Conversation

jeremycline
Copy link
Member

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.

@dustymabe
Copy link

I think it would have helped me today if we add an example of calling that example class via the CLI. i.e. fedora-messaging --conf /work/my_config.toml consume --callback=modname:SaveMessage

Copy link
Contributor

@bowlofeggs bowlofeggs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
object as a single position argument.
object as a single positional argument.

Copy link
Member Author

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-io
Copy link

codecov-io commented May 21, 2019

Codecov Report

Merging #177 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          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.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bd5d4de...014a348. Read the comment docs.

@jeremycline
Copy link
Member Author

I think it would have helped me today if we add an example of calling that example class via the CLI. i.e. fedora-messaging --conf /work/my_config.toml consume --callback=modname:SaveMessage

I've added a note following the example class.

@dustymabe
Copy link

I think it would have helped me today if we add an example of calling that example class via the CLI. i.e. fedora-messaging --conf /work/my_config.toml consume --callback=modname:SaveMessage

I've added a note following the example class.

👍

@jeremycline jeremycline merged commit 014a348 into fedora-infra:master May 21, 2019
@jeremycline jeremycline deleted the doc-class branch May 21, 2019 19:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants