Skip to content

Remove internal method mention from 'Transaction support' in README.md #763

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.

Sign up for GitHub

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

Open
ovedanner wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Remove internal method mention from 'Transaction support' in README.md #763

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1012,12 +1012,11 @@ Since version *3.0.13* AASM supports ActiveRecord transactions. So whenever a tr
callback or the state update fails, all changes to any database record are rolled back.
Mongodb does not support transactions.

There are currently 3 transactional callbacks that can be handled on the event, and 2 transactional callbacks for all events.
There are currently 3 transactional callbacks that can be handled on the event, and 2 transactional callbacks for all events:

```ruby
event before_all_transactions
event before_transaction
event aasm_fire_event (within transaction)

@alto alto Jun 20, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@ovedanner I do agree, the method aasm_fire_event shouldn't be mentioned here. But we still need an indicator to show that this is the time when the actual event is fire. Maybe replacing the line with

                  <event fired>

would help? What do you think?

event after_commit (if event successful)
event after_transaction
event after_all_transactions
Expand Down