Doc: Format CSRF argument lists

seanpdoyle · seanpdoyle · commit 93318efba4ba · 2025-01-18T09:11:46.000-05:00
Add newlines to the `ActionController::RequestForgeryProtection` method
documention to treat `*`-prefixed lines as `&lt;li&gt;` elements.
diff --git a/actionpack/lib/action_controller/metal/request_forgery_protection.rb b/actionpack/lib/action_controller/metal/request_forgery_protection.rb
@@ -149,6 +149,7 @@ module ClassMethods
       #
       #
       # Built-in unverified request handling methods are:
+      #
       # *   `:exception` - Raises ActionController::InvalidAuthenticityToken
       #     exception.
       # *   `:reset_session` - Resets the session.
@@ -177,6 +178,7 @@ module ClassMethods
       #
       #
       # Built-in session token strategies are:
+      #
       # *   `:session` - Store the CSRF token in the session.  Used as default if
       #     `:store` option is not specified.
       # *   `:cookie` - Store the CSRF token in an encrypted cookie.

Original file line number	Diff line number	Diff line change
`@@ -149,6 +149,7 @@ module ClassMethods`
`149`	`149`	`#`
`150`	`150`	`#`
`151`	`151`	`# Built-in unverified request handling methods are:`
	`152`	`+ #`
`152`	`153`	# * `:exception` - Raises ActionController::InvalidAuthenticityToken
`153`	`154`	`# exception.`
`154`	`155`	# * `:reset_session` - Resets the session.
`@@ -177,6 +178,7 @@ module ClassMethods`
`177`	`178`	`#`
`178`	`179`	`#`
`179`	`180`	`# Built-in session token strategies are:`
	`181`	`+ #`
`180`	`182`	# * `:session` - Store the CSRF token in the session. Used as default if
`181`	`183`	# `:store` option is not specified.
`182`	`184`	# * `:cookie` - Store the CSRF token in an encrypted cookie.