Skip to content

Commit 22bdccd

Browse files
committed
📝 Documentation fixes
1 parent e28d91e commit 22bdccd

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -377,7 +377,7 @@ This gem is tested against MRI, JRuby, and Truffleruby.
377377
Each of those has varying versions that target a specific version of MRI Ruby.
378378
This gem should work in the just-listed Ruby engines according to the targeted MRI compatibility in the table below.
379379
If you would like to add support for additional engines,
380-
see `gemfiles/README.md`, then submit a PR to the correct maintenance branch as according to the table below.
380+
see [gemfiles/README.md](gemfiles/README.md), then submit a PR to the correct maintenance branch as according to the table below.
381381
</details>
382382

383383
<details>
@@ -404,25 +404,25 @@ of a major release, support for that Ruby version may be dropped.
404404
| 3️⃣ | older | N/A | Best of luck to you! | Please upgrade! | |
405405

406406
NOTE: The 1.4 series will only receive critical security updates.
407-
See [SECURITY.md][🚎sec-pol]
407+
See [SECURITY.md][🔐security].
408408

409409
## Usage Examples
410410

411411
### Global Configuration
412412

413-
If you started seeing this warning, but everything is working fine, you can now silence it.
414-
```log
415-
OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key
416-
```
413+
You can turn on additional warnings.
417414

418415
```ruby
419416
OAuth2.configure do |config|
420-
config.silence_extra_tokens_warning = true # default: false
421-
config.silence_no_tokens_warning = true # default: false, if you want to also silence warnings about no tokens
417+
# Turn on a warning like:
418+
# OAuth2::AccessToken.from_hash: `hash` contained more than one 'token' key
419+
config.silence_extra_tokens_warning = false # default: true
420+
# Set to true if you want to also show warnings about no tokens
421+
config.silence_no_tokens_warning = false # default: true,
422422
end
423423
```
424424

425-
This comes from ambiguity in the spec about which token is the right token.
425+
The "extra tokens" problem comes from ambiguity in the spec about which token is the right token.
426426
Some OAuth 2.0 standards legitimately have multiple tokens.
427427
You may need to subclass `OAuth2::AccessToken`, or write your own custom alternative to it, and pass it in.
428428
Specify your custom class with the `access_token_class` option.

0 commit comments

Comments
 (0)