Tweak MessageVerifier :urlsafe option doc [ci-skip]

jonathanhefner · jonathanhefner · commit 1003e974ed9c · 2022-06-22T11:21:10.000-05:00
Follow-up to rails#45425. This fixes a few typos, and slightly adjusts the wording.
diff --git a/activesupport/lib/active_support/message_verifier.rb b/activesupport/lib/active_support/message_verifier.rb
@@ -108,13 +108,13 @@ module ActiveSupport
   #
   #   verifier.rotate(old_secret, digest: "SHA256", serializer: Marshal)
   #
-  # === Generating urlsafe strings
+  # === Generating URL safe strings
   #
-  # By default MessageVerifier generates RFC 4648 complient strings which are
-  # not urlsafe. In other words, they can contain "+" and "/". If you want to
-  # generate urlsafe strings (complie with “Base 64 Encoding with URL and
-  # Filename Safe Alphabet” in RFC 4648), you can pass urlsafe upon
-  # initialization:
+  # By default MessageVerifier generates RFC 4648 compliant strings which are
+  # not URL safe. In other words, they can contain "+" and "/". If you want to
+  # generate URL safe strings (in compliance with "Base 64 Encoding with URL and
+  # Filename Safe Alphabet" in RFC 4648), you can pass <tt>urlsafe: true</tt>
+  # to the constructor:
   #
   #   @verifier = ActiveSupport::MessageVerifier.new("secret", urlsafe: true)
   #   @verifier.generate("signed message") #=> "urlsafe_string"

Original file line number	Diff line number	Diff line change
`@@ -108,13 +108,13 @@ module ActiveSupport`
`108`	`108`	`#`
`109`	`109`	`# verifier.rotate(old_secret, digest: "SHA256", serializer: Marshal)`
`110`	`110`	`#`
`111`		`- # === Generating urlsafe strings`
	`111`	`+ # === Generating URL safe strings`
`112`	`112`	`#`
`113`		`- # By default MessageVerifier generates RFC 4648 complient strings which are`
`114`		`- # not urlsafe. In other words, they can contain "+" and "/". If you want to`
`115`		`- # generate urlsafe strings (complie with “Base 64 Encoding with URL and`
`116`		`- # Filename Safe Alphabet” in RFC 4648), you can pass urlsafe upon`
`117`		`- # initialization:`
	`113`	`+ # By default MessageVerifier generates RFC 4648 compliant strings which are`
	`114`	`+ # not URL safe. In other words, they can contain "+" and "/". If you want to`
	`115`	`+ # generate URL safe strings (in compliance with "Base 64 Encoding with URL and`
	`116`	`+ # Filename Safe Alphabet" in RFC 4648), you can pass <tt>urlsafe: true</tt>`
	`117`	`+ # to the constructor:`
`118`	`118`	`#`
`119`	`119`	`# @verifier = ActiveSupport::MessageVerifier.new("secret", urlsafe: true)`
`120`	`120`	`# @verifier.generate("signed message") #=> "urlsafe_string"`