docs: Update OTP::ActiveRecord#verify_otp docs (#17)

ayerdines · web-flow · commit 43eebcf72ddd · 2024-03-30T12:48:14.000Z
diff --git a/lib/otp/active_record.rb b/lib/otp/active_record.rb
@@ -32,7 +32,7 @@ def otp
 
     # Verifies the OTP
     #
-    # @return true on success, false on failure
+    # @return otp_counter on success, nil on failure
     def verify_otp(otp)
       return nil if !valid? || !persisted? || otp_secret.blank?
 

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ def otp`
`32`	`32`
`33`	`33`	`# Verifies the OTP`
`34`	`34`	`#`
`35`		`- # @return true on success, false on failure`
	`35`	`+ # @return otp_counter on success, nil on failure`
`36`	`36`	`def verify_otp(otp)`
`37`	`37`	`return nil if !valid? \|\| !persisted? \|\| otp_secret.blank?`
`38`	`38`