Further document VerificationError types, turn them into records #117
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
With this commit all arguments of functions with 2 or more arguments that are exported via Crypto.WebAuthn are documented.
This allows documentation of the individual fields.
ErinvanderVeen
force-pushed
the
function-argument-documentation
branch
from
3d4409f
to
4c2363e
Compare
ErinvanderVeen
added a commit
that referenced
this pull request
Jan 26, 2022
infinisil
force-pushed
the
function-argument-documentation
branch
from
1b7b31b
to
851c78d
Compare
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.
Expand documentation of the
VerificationErrorsproduced by the differentattestation statement formats, and turn any of them with an arity higher than 2
into a record. This allows for per-field documentation. Most errors were also
renamed to be more consistent and the
VerificationError-prefix was droppedwhere present. Patternmatching on specific errors wherever used must be
changed to accomodate this change. Additionally, missing documentation for the
arguments of the
lookupAttestationStatementFormatfunction was added.