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.

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

Update Userstamp callbacks in README.md to match the code #34

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

Update Userstamp callbacks in README.md to match the code #34

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Mongoid::Userstamp is tested on the following versions:
Mongoid::Userstamp does the following:
* Defines Mongoid `belongs_to` relations to the user class for `created_by` and `updated_by` on each class where `Mongoid::Userstamp` is included
* Automatically tracks the current user via a `before_filter` (see Rails Integration below)
* Sets the `created_by` and `updated_by` values in `before_save` and `before_update` callbacks respectively on the target models.
* Sets the `created_by` and `updated_by` values in `before_create` and `before_save` callbacks respectively on the target models.
* Adds methods to the user class to check for the current user.

```ruby
Expand Down Expand Up @@ -76,7 +76,7 @@ Mongoid::Userstamp will not overwrite manually set values in the `creator` and `

* The `creator` is only set during the creation of new models (`before_create` callback). Mongoid::Userstamp will not
overwrite the `creator` field if it already contains a value (i.e. was manually set.)
* The `updater` is set each time the model is saved (`before_create` callback), which includes the initial
* The `updater` is set each time the model is saved (`before_save` callback), which includes the initial
creation. Mongoid::Userstamp will not overwrite the `updater` field if it been modified since the last save, as
per Mongoid's built-in "dirty tracking" feature.

Expand Down