Some slight doc improvements in rack-protection #2072
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ALthough it reads better in the source code file, the rendering creates code blocks the additional lines.
davetron5000
commented
Nov 29, 2024
| # | ||
| # These may be given to any subclass, however they may affect different subclasses differently. | ||
| # | ||
| # [<tt>:reaction</tt>] - name of a method of the class that will be used to respond when the middleware rejects the response. Default behavior is to use #default_reaction. |
There was a problem hiding this comment.
These options are all really useful and I didn't know about them until I started reading the source.
|
Was it necessary to remove the line breaks? There's some very long lines now |
|
@dentarg Sorry, I think I mis-interpreted why the formatting was broken and assumed it was the existence of any linebreak. In reality, it's just when subsequent lines don't line up with the original bullet point. I've reformatted to make things more readable (I think). See e2dfc1d If that's not exactly right, let me know your ideal # of columns and I can re-reformat. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem(s)
Base rack protection middleware does not document its options, and I found them hard to know about due to this absent documentation
Formatting of
Rack::Protection::AuthenticityTokens options rendered incorrectly (see screenshot)Rack::Protection::ContentSecurityPolicy's docs were not specific as to the behavior of the classSolution
Updated the docs. I started to look at all the classes for a doc update, but decided to stop here as these addressed my issue and I wasn't sure if this sorts of changes would be accepted. If they are, I would happy to refresh the docs in the other classes.