Skip to content

Commit e9074da

Browse files
committed
📝 Documentation updates
1 parent 067fbad commit e9074da

30 files changed

+768
-245
lines changed

.rubocop_gradual.lock

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
[9, 9, 25, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 2012823020],
1919
[13, 9, 25, "ThreadSafety/ClassInstanceVariable: Avoid class instance variables.", 2012823020]
2020
],
21-
"lib/oauth2/response.rb:3727627041": [
22-
[36, 5, 204, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 996912427]
21+
"lib/oauth2/response.rb:2054901929": [
22+
[53, 5, 204, "Style/ClassMethodsDefinitions: Use `class << self` to define a class method.", 996912427]
2323
],
2424
"oauth2.gemspec:3059367295": [
2525
[5, 23, 12, "Gemspec/RubyVersionGlobalsUsage: Do not use `RUBY_VERSION` in gemspec file.", 31296028]

CHANGELOG.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,34 +6,34 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
66

77
## [Unreleased]
88
### Added
9-
- Codeberg as ethical mirror (@pboling)
10-
- https://codeberg.org/oauth-xx/oauth2
11-
- Don't check for cert if SKIP_GEM_SIGNING is set (@pboling)
12-
- All runtime deps, including oauth-xx sibling gems, are now tested against HEAD (@pboling)
13-
- YARD config, GFM compatible with relative file links
14-
- Documentation site on GitHub Pages
15-
- [oauth2.galtzo.com](https://oauth2.galtzo.com)
16-
- [!649](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/649) - Test compatibility with all key minor versions of Hashie v0, v1, v2, v3, v4, v5, HEAD
179
### Changed
18-
- Updated `spec.homepage_uri` in gemspec to GitHub Pages YARD documentation site
1910
### Deprecated
2011
### Removed
2112
### Fixed
22-
- Incorrect documentation related to silencing warnings (@pboling)
2313
### Security
2414

25-
## [2.0.11] - 2025-05-22
15+
## [2.0.11] - 2025-05-23
2616
- TAG: [v2.0.11][2.0.11t]
27-
- COVERAGE: 100.00% -- 516/516 lines in 14 files
28-
- BRANCH COVERAGE: 100.00% -- 170/170 branches in 14 files
29-
- 79.05% documented
17+
- COVERAGE: 100.00% -- 518/518 lines in 14 files
18+
- BRANCH COVERAGE: 100.00% -- 172/172 branches in 14 files
19+
- 80.00% documented
3020
### Added
3121
- More documentation
22+
- Codeberg as ethical mirror (@pboling)
23+
- https://codeberg.org/oauth-xx/oauth2
24+
- Don't check for cert if SKIP_GEM_SIGNING is set (@pboling)
25+
- All runtime deps, including oauth-xx sibling gems, are now tested against HEAD (@pboling)
26+
- YARD config, GFM compatible with relative file links (@pboling)
27+
- Documentation site on GitHub Pages (@pboling)
28+
- [oauth2.galtzo.com](https://oauth2.galtzo.com)
29+
- [!649](https://gitlab.com/oauth-xx/oauth2/-/merge_requests/649) - Test compatibility with all key minor versions of Hashie v0, v1, v2, v3, v4, v5, HEAD (@pboling)
3230
### Changed
33-
- Upgraded to snaky_hash v2.0.2
31+
- Upgraded to snaky_hash v2.0.2 (@pboling)
3432
- Provides solution for serialization issues
33+
- Updated `spec.homepage_uri` in gemspec to GitHub Pages YARD documentation site (@pboling)
3534
### Fixed
36-
- [gh650](https://github.com/oauth-xx/oauth2/pull/650) - Regression in return type of `OAuth2::Response#parsed`
35+
- [gh650](https://github.com/oauth-xx/oauth2/pull/650) - Regression in return type of `OAuth2::Response#parsed` (@pboling)
36+
- Incorrect documentation related to silencing warnings (@pboling)
3737

3838
## [2.0.10] - 2025-05-17
3939
- TAG: [v2.0.10][2.0.10t]
@@ -392,7 +392,9 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
392392

393393
[gemfiles/readme]: gemfiles/README.md
394394

395-
[Unreleased]: https://gitlab.com/oauth-xx/oauth2/-/compare/v2.0.10...HEAD
395+
[Unreleased]: https://gitlab.com/oauth-xx/oauth2/-/compare/v2.0.11...HEAD
396+
[2.0.11]: https://gitlab.com/oauth-xx/oauth2/-/compare/v2.0.10...v2.0.11
397+
[2.0.11t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v2.0.11
396398
[2.0.10]: https://gitlab.com/oauth-xx/oauth2/-/compare/v2.0.9...v2.0.10
397399
[2.0.10t]: https://gitlab.com/oauth-xx/oauth2/-/tags/v2.0.10
398400
[2.0.9]: https://gitlab.com/oauth-xx/oauth2/-/compare/v2.0.8...v2.0.9

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -885,7 +885,7 @@ or one of the others at the head of this README.
885885
[📌gitmoji]:https://gitmoji.dev
886886
[📌gitmoji-img]:https://img.shields.io/badge/gitmoji_commits-%20😜%20😍-34495e.svg?style=flat-square
887887
[🧮kloc]: https://www.youtube.com/watch?v=dQw4w9WgXcQ
888-
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.516-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
888+
[🧮kloc-img]: https://img.shields.io/badge/KLOC-0.518-FFDD67.svg?style=for-the-badge&logo=YouTube&logoColor=blue
889889
[🔐security]: SECURITY.md
890890
[🔐security-img]: https://img.shields.io/badge/security-policy-259D6C.svg?style=flat
891891
[📄copyright-notice-explainer]: https://opensource.stackexchange.com/questions/5778/why-do-licenses-such-as-the-mit-license-specify-a-single-year

doc/OAuth2.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ <h3 class="signature first" id="configure-class_method">
326326
</div>
327327

328328
<div id="footer">
329-
Generated on Fri May 23 10:50:57 2025 by
329+
Generated on Fri May 23 11:14:08 2025 by
330330
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
331331
0.9.37 (ruby-3.4.3).
332332
</div>

doc/OAuth2/AccessToken.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3069,7 +3069,7 @@ <h3 class="signature " id="to_hash-instance_method">
30693069
</div>
30703070

30713071
<div id="footer">
3072-
Generated on Fri May 23 10:50:57 2025 by
3072+
Generated on Fri May 23 11:14:09 2025 by
30733073
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
30743074
0.9.37 (ruby-3.4.3).
30753075
</div>

doc/OAuth2/Authenticator.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -631,7 +631,7 @@ <h3 class="signature first" id="apply-instance_method">
631631
</div>
632632

633633
<div id="footer">
634-
Generated on Fri May 23 10:50:57 2025 by
634+
Generated on Fri May 23 11:14:09 2025 by
635635
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
636636
0.9.37 (ruby-3.4.3).
637637
</div>

doc/OAuth2/Client.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2651,7 +2651,7 @@ <h3 class="signature " id="token_url-instance_method">
26512651
</div>
26522652

26532653
<div id="footer">
2654-
Generated on Fri May 23 10:50:57 2025 by
2654+
Generated on Fri May 23 11:14:08 2025 by
26552655
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
26562656
0.9.37 (ruby-3.4.3).
26572657
</div>

doc/OAuth2/Error.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -518,7 +518,7 @@ <h3 class="signature " id="response-instance_method">
518518
</div>
519519

520520
<div id="footer">
521-
Generated on Fri May 23 10:50:57 2025 by
521+
Generated on Fri May 23 11:14:08 2025 by
522522
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
523523
0.9.37 (ruby-3.4.3).
524524
</div>

doc/OAuth2/FilteredAttributes.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -268,7 +268,7 @@ <h3 class="signature first" id="inspect-instance_method">
268268
</div>
269269

270270
<div id="footer">
271-
Generated on Fri May 23 10:50:57 2025 by
271+
Generated on Fri May 23 11:14:08 2025 by
272272
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
273273
0.9.37 (ruby-3.4.3).
274274
</div>

doc/OAuth2/FilteredAttributes/ClassMethods.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ <h3 class="signature " id="filtered_attributes-instance_method">
218218
</div>
219219

220220
<div id="footer">
221-
Generated on Fri May 23 10:50:57 2025 by
221+
Generated on Fri May 23 11:14:08 2025 by
222222
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
223223
0.9.37 (ruby-3.4.3).
224224
</div>

0 commit comments

Comments
 (0)