Improve documentation #157
Merged
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
robinbrandt
force-pushed
the
improve-docs
branch
from
7e1aa40
to
c9591ef
Compare
This changes the variable names of the examples slightly to use the commonly used w for the ResponseWriter and removes the clash with the WebAuthn instance. Signed-off-by: Robin Brandt <[email protected]>
The examples can be simplified to use the convenience functions offered by the library. Signed-off-by: Robin Brandt <[email protected]>
robinbrandt
force-pushed
the
improve-docs
branch
from
c9591ef
to
51d3f55
Compare
|
Hey thanks for submitting this, I had meaned to look at it last week and provide feedback but ended up forgetting! Whoops! I'm sorry about this. I'll get to it today hopefully. |
|
As someone looking at this library for the first time, I found the changes @robinbrandt proposed here very useful for clearing up some of my confusion about the readme examples. 👍 |
james-d-elliott
approved these changes
Oct 6, 2023
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.
Hi!
Thanks for continuing to maintain the library. A couple of suggestions to improve the examples in the README.
wfor both theResponseWriterand thewebauthn.WebAuthninstance. The official go docs usewfor the ResponseWriter so I suggest to optimize for familiarity and give theWebAuthninstance a new nameFinishLoginandFinishRegistration(unless I'm missing something why the shouldn't be used)