Fix example of Crypto::BCrypt.new(String, String, Int).

hugopl · hugopl · commit f293a0dc681e · 2025-06-26T19:32:54.000-03:00
diff --git a/src/crypto/bcrypt.cr b/src/crypto/bcrypt.cr
@@ -72,10 +72,12 @@ class Crypto::Bcrypt
 
   # Creates a new `Crypto::Bcrypt` object from the given *password* with *salt* and *cost*.
   #
+  # *salt* must be a base64 encoded string of 16 bytes (128 bits).
+  #
   # ```
   # require "crypto/bcrypt"
   #
-  # password = Crypto::Bcrypt.new "secret", "salt_of_16_chars"
+  # password = Crypto::Bcrypt.new "secret", "0102030405060708090a0b0c0d0e0f10"
   # password.digest
   # ```
   def self.new(password : String, salt : String, cost = DEFAULT_COST)

Original file line number	Diff line number	Diff line change
`@@ -72,10 +72,12 @@ class Crypto::Bcrypt`
`72`	`72`
`73`	`73`	# Creates a new `Crypto::Bcrypt` object from the given password with salt and cost.
`74`	`74`	`#`
	`75`	`+ # salt must be a base64 encoded string of 16 bytes (128 bits).`
	`76`	`+ #`
`75`	`77`	# ```
`76`	`78`	`# require "crypto/bcrypt"`
`77`	`79`	`#`
`78`		`- # password = Crypto::Bcrypt.new "secret", "salt_of_16_chars"`
	`80`	`+ # password = Crypto::Bcrypt.new "secret", "0102030405060708090a0b0c0d0e0f10"`
`79`	`81`	`# password.digest`
`80`	`82`	# ```
`81`	`83`	`def self.new(password : String, salt : String, cost = DEFAULT_COST)`