Minor docs improvements, mostly around Verify* plugs #692
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
|
Hey there, my apologies for the delay, thank you so much for your help. Do you mind rebasing? |
This will have the additional effect of those lists actually being rendered as such in the HTML docs. Also make it clearer that what happens is that any of those conditions not being met is sufficient.
Consistent with the deprecation attribute in the code
…s found Also, fix the doc for VerifyHeader that refers to the session instead of to the header.
alopezz
force-pushed
the
improve-verify-x-docs
branch
from
295ecc4
to
790b12d
Compare
|
Rebased just now. |
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.
What prompted me to work on this was that as I was trying to add some custom verification logic, it wasn't obvious to me from the documentation that the
Verify*plugs would let a session without a token (e.g. a logged out session) pass, and thatEnsureAuthenticatedis typically used for little more than checking that a token is present.So this tries to be more clear on that, and takes the opportunity to do some other minor fixups as well.