Skip to content

Commit

Permalink
Docs: #reference and #sha1 use base, not canonical [ci skip]
Browse files Browse the repository at this point in the history
  • Loading branch information
eliotsykes authored and afair committed Jul 1, 2021
1 parent e25dc23 commit 5471bef
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions lib/email_address/address.rb
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ def munge
[local.munge, host.munge].join("@")
end

# Returns and MD5 of the canonical address form. Some cross-system systems
# Returns and MD5 of the base address form. Some cross-system systems
# use the email address MD5 instead of the actual address to refer to the
# same shared user identity without exposing the actual address when it
# is not known in common.
Expand All @@ -169,7 +169,7 @@ def reference(form = :base)
end
alias md5 reference

# This returns the SHA1 digest (in a hex string) of the canonical email
# This returns the SHA1 digest (in a hex string) of the base email
# address. See #md5 for more background.
def sha1(form = :base)
Digest::SHA1.hexdigest((send(form) || "") + (@config[:sha1_secret] || ""))
Expand Down

0 comments on commit 5471bef

Please sign in to comment.