-
Notifications
You must be signed in to change notification settings - Fork 15
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
Batch API docs #290
Merged
akotlar
merged 10 commits into
bystrogenomics:master
from
akotlar:feature/284_batch_api_docs
Oct 16, 2023
Merged
Batch API docs #290
akotlar
merged 10 commits into
bystrogenomics:master
from
akotlar:feature/284_batch_api_docs
Oct 16, 2023
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
akotlar
commented
Oct 16, 2023
- Partially addresses issue Send Carsten API docs #284 by adding API documentation
docs/batch_api.md
Outdated
Briefly, Beanstalkd is a simple pub-sub protocol that features persistence and which has the performance of Redis. However, unlike Redis, it has useful features that make it approprirate for a job queue: | ||
|
||
- Exactly once delivery semantics: A message can be reserved by only a single beanstlakd client at a time. | ||
- TTR: If a message is reserved for too long, it will be released back for further reservation, to guard against workers that lose connectivity |
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.
Can you spell out TTR after the abbreviation?
cristinaetrv
approved these changes
Oct 16, 2023
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.
I had a few grammar/typo suggestions, but overall lgtm!
Co-authored-by: cristinaetrv <24943967+cristinaetrv@users.noreply.github.com>
Co-authored-by: cristinaetrv <24943967+cristinaetrv@users.noreply.github.com>
Co-authored-by: cristinaetrv <24943967+cristinaetrv@users.noreply.github.com>
Co-authored-by: cristinaetrv <24943967+cristinaetrv@users.noreply.github.com>
Co-authored-by: cristinaetrv <24943967+cristinaetrv@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.