Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update HWK option documentation #979

Merged
merged 2 commits into from
Sep 8, 2023
Merged

Update HWK option documentation #979

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
837a848
Update option documentation
lestrrat Sep 8, 2023
f9102b5
reinstance CacheOption
lestrrat Sep 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions jwk/options.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ interfaces:
- name: CacheOption
comment: |
CacheOption is a type of Option that can be passed to the
`jwk.Cache` object.
the `jwk.NewCache()` function.
- name: AssignKeyIDOption
- name: FetchOption
methods:
Expand All @@ -13,8 +13,8 @@ interfaces:
- registerOption
comment: |
FetchOption is a type of Option that can be passed to `jwk.Fetch()`
FetchOption also implements the `CacheOption`, and thus can
safely be passed to `(*jwk.Cache).Configure()`
FetchOption also implements the `RegisterOption`, and thus can
safely be passed to `(*jwk.Cache).Register()`
- name: ParseOption
methods:
- fetchOption
Expand Down
6 changes: 3 additions & 3 deletions jwk/options_gen.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.