Skip to content

Commit e86da63

Browse files
committed
📝 Documentation updates
1 parent 6568de9 commit e86da63

File tree

3 files changed

+12
-6
lines changed

3 files changed

+12
-6
lines changed

CHANGELOG.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,12 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
1111
### Removed
1212

1313
## [2.0.10] - 2025-05-XX ([tag][2.0.10t])
14+
- COVERAGE: 100.00% -- 518/518 lines in 14 files
15+
- BRANCH COVERAGE: 100.00% -- 170/170 branches in 14 files
16+
- 79.05% documented
1417
### Added
15-
- [!635](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/635) - `.gitlab-ci.yml` file (@jessieay)
18+
- [gh!632](https://github.com/oauth-xx/oauth2/pull/632) - Added `funding.yml` (@Aboling0)
19+
- [!635](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/635) - Added `.gitlab-ci.yml` (@jessieay)
1620
- [#638](https://gitlab.com/oauth-xx/oauth2/-/issues/638) - Documentation of support for ILO Fundamental Principles of Rights at Work
1721
- [!642](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/642) - 20 year certificate for signing gem releases, expires 2045-04-29 (@pboling)
1822
- Gemspec metadata (@pboling)
@@ -28,16 +32,17 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
2832
- `OAuth2::Client#revoke_token`
2933
- `OAuth2::AccessToken#revoke`
3034
- See: https://datatracker.ietf.org/doc/html/rfc7009
35+
- [gh!644](https://github.com/oauth-xx/oauth2/pull/644), [gh!645](https://github.com/oauth-xx/oauth2/pull/645) - Added CITATION.cff (@Aboling0)
3136
### Changed
3237
- Default value of `OAuth2.config.silence_extra_tokens_warning` was `false`, now `true`
3338
- Gem releases are now cryptographically signed, with a 20-year cert (@pboling)
34-
- Allow linux distros to build release without signing, as their package managers sign independently
39+
- Allow linux distros to build release without signing, as their package managers sign independently
3540
- [!647](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/647) - `OAuth2::AccessToken#refresh` now supports block param pass through (@pboling)
3641
- [!647](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/647) - `OAuth2.config` is no longer writable (@pboling)
3742
- [!647](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/647) - Errors raised by OAuth2::AccessToken are now always OAuth2::Error and have better metadata (@pboling)
3843
### Fixed
3944
- [#95](https://gitlab.com/oauth-xx/oauth2/-/issues/95) - restoring an access token via `AccessToken#from_hash` (@pboling)
40-
- This was a 13 year old bug report. 😘
45+
- This was a 13 year old bug report. 😘
4146
- [#619](https://gitlab.com/oauth-xx/oauth2/-/issues/619) - Internal options (like snaky, raise_errors, and parse) are no longer included in request (@pboling)
4247
- [!633](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/633) - Spaces will now be encoded as `%20` instead of `+` (@nov.matake)
4348
- [!634](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/634) - `CHANGELOG.md` documentation fix (@skuwa229)
@@ -48,6 +53,7 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
4853
- [!641](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/641) - Do not include sensitive information in the `inspect` (@manuelvanrijn)
4954
- [#641](https://gitlab.com/oauth-xx/oauth2/-/issues/641) - Made default JSON response parser more resilient (@pboling)
5055
- [#645](https://gitlab.com/oauth-xx/oauth2/-/issues/645) - Response no longer becomes a snaky hash (@pboling)
56+
- [gh!646](https://github.com/oauth-xx/oauth2/pull/646) - Change require to require_relative (improve performance) (@Aboling0)
5157

5258
## [2.0.9] - 2022-09-16 ([tag][2.0.9t])
5359
### Added

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
</a>
88
</p>
99

10-
## OAuth2
10+
## 🔐 OAuth2
1111

1212
[![Version][👽versioni]][👽version]
1313
[![License: MIT][📄license-img]][📄license-ref]
@@ -753,7 +753,7 @@ or one of the others at the head of this README.
753753
[📌gitmoji]:https://gitmoji.dev
754754
[📌gitmoji-img]:https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square
755755
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
756-
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.073-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
756+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.518-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
757757
[🔐security]: SECURITY.md
758758
[🔐security-img]: https://img.shields.io/badge/security-policy-brightgreen.svg?style=flat
759759
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year

lib/oauth2/client.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ def revoke_url(params = nil)
129129
#
130130
# @param [Symbol] verb one of [:get, :post, :put, :delete]
131131
# @param [String] url URL path of request
132-
# @param [Hash] opts the options to make the request with
132+
# @param [Hash] req_opts the options to make the request with
133133
# @option req_opts [Hash] :params additional query parameters for the URL of the request
134134
# @option req_opts [Hash, String] :body the body of the request
135135
# @option req_opts [Hash] :headers http request headers

0 commit comments

Comments
 (0)