1
0
Fork 0
mirror of https://github.com/heartcombo/devise.git synced 2022-11-09 12:18:31 -05:00

Add some docs to the send email/password notification settings [ci skip]

This commit is contained in:
Carlos Antonio da Silva 2017-03-06 17:33:34 -03:00
parent 0a9e2c961f
commit d7f6855ad8
2 changed files with 7 additions and 1 deletions

View file

@ -26,7 +26,9 @@ module Devise
# initial account confirmation) to be applied. Requires additional unconfirmed_email
# db field to be set up (t.reconfirmable in migrations). Until confirmed, new email is
# stored in unconfirmed email column, and copied to email column on successful
# confirmation.
# confirmation. Also, when used in conjunction with `send_email_change_notification`,
# the notification is sent to the original email when the change is requested,
# not when the unconfirmed email is confirmed.
# * +confirm_within+: the time before a sent confirmation token becomes invalid.
# You can use this to force the user to confirm within a set period of time.
# Confirmable will not generate a new token if a repeat confirmation is requested

View file

@ -14,6 +14,10 @@ module Devise
#
# * +stretches+: the cost given to bcrypt.
#
# * +send_email_change_notification+: notify original email when it changes.
#
# * +send_password_change_notification+: notify email when password changes.
#
# == Examples
#
# User.find(1).valid_password?('password123') # returns true/false