Explain the skip_jobs parameter

This commit is contained in:
Robin Ward 2016-08-24 11:05:49 -04:00
parent 038eb6f645
commit 79245a25a3

View File

@ -32,6 +32,10 @@ class PostCreator
# via_email - Mark this post as arriving via email
# raw_email - Full text of arriving email (to store)
# action_code - Describes a small_action post (optional)
# skip_jobs - Don't enqueue jobs when creation succeeds. This is needed if you
# wrap `PostCreator` in a transaction, as the sidekiq jobs could
# dequeue before the commit finishes. If you do this, be sure to
# call `enqueue_jobs` after the transaction is comitted.
#
# When replying to a topic:
# topic_id - topic we're replying to