Add top level & method documentation into Devise::Passkeys::Model #12
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
|
Let me know if I should add more comments, but imho this module seems rather straightforward |
* Markdown is widly supported & used across the industry (especially when compared to RDOC)
* Added some more clarity about how the method is added * Note that `after_passkey_authentication` is a no-op by default, but can be overridden
tcannonfodder
approved these changes
Jun 23, 2023
There was a problem hiding this comment.
Thanks so much for this documentation!
I made some minor edits, but I agree, it's pretty straightforward. Reviewing the docs actually helped me see that there's an improvement we could make to the callback (#14)
Also, if you haven't yet, check out the discussion in #2 for our overall documentation plan :)
|
Nice catch with the parameter 👍 |
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.
No description provided.