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

queue: add documentation #63

Merged
merged 2 commits into from Mar 13, 2019

Conversation

Projects
None yet
2 participants
@pierre
Copy link
Member

pierre commented Mar 13, 2019

Add some implementation notes, since the library is becoming more popular.

Reading the rendered output might be the easiest: https://github.com/killbill/killbill-commons/blob/docs-update/queue/README.md

queue: add documentation
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>

@pierre pierre requested a review from sbrossie Mar 13, 2019

@sbrossie
Copy link
Member

sbrossie left a comment

Looks good. 2 comments:

  1. One thing to add -- unless i messed it -- is that handlers need to be idempotent as they could be retried.
  2. Nit: Formatting seems weird, lots of line cut, not sure if this will be reflected after this has been rendered though
queue: add note about idempotency
Signed-off-by: Pierre-Alexandre Meyer <pierre@mouraf.org>
@pierre

This comment has been minimized.

Copy link
Member Author

pierre commented Mar 13, 2019

  1. One thing to add -- unless i messed it -- is that handlers need to be idempotent as they could be retried.

Good point, fixed in 8e3e550.

  1. Nit: Formatting seems weird, lots of line cut, not sure if this will be reflected after this has been rendered though

It's because I wrote it with new lines at 120 chars or so to avoid overly long lines. Doesn't impact rendering.

@pierre pierre merged commit 5d736e9 into master Mar 13, 2019

1 of 4 checks passed

ci/circleci: test-h2 CircleCI is running your tests
Details
ci/circleci: test-mysql CircleCI is running your tests
Details
ci/circleci: test-postgresql CircleCI is running your tests
Details
ci/circleci: build Your tests passed on CircleCI!
Details

@pierre pierre deleted the docs-update branch Mar 13, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.