-
-
Notifications
You must be signed in to change notification settings - Fork 158
📝 Complete inline YARD docs #111
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.
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
Conversation
pboling
commented
Nov 10, 2025
- Upgrade dependencies
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #111 +/- ##
==========================================
- Coverage 96.82% 96.78% -0.05%
==========================================
Files 4 4
Lines 315 311 -4
Branches 117 117
==========================================
- Hits 305 301 -4
Misses 10 10 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances the codebase documentation by adding comprehensive YARD documentation across the main library files and updates development dependencies. The changes primarily focus on improving code documentation coverage while also modernizing the development toolchain.
- Added extensive YARD documentation to
lib/omniauth/strategies/ldap.rb,lib/omniauth-ldap/adaptor.rb,lib/omniauth-ldap/version.rb, andlib/omniauth-ldap.rb - Updated development dependencies including
kettle-dev(v1.1.45 → v1.1.54), removedvcrandwebmockdependencies - Enhanced documentation tooling with
yard-fence,yard-yaml, andyaml-converter
Reviewed Changes
Copilot reviewed 58 out of 63 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
lib/omniauth/strategies/ldap.rb |
Added comprehensive YARD documentation for the LDAP strategy class, methods, and constants |
lib/omniauth-ldap/adaptor.rb |
Added detailed YARD documentation for the Adaptor class, configuration constants, and methods |
lib/omniauth-ldap/version.rb |
Added YARD documentation for the version module and constants |
lib/omniauth-ldap.rb |
Added module-level YARD documentation |
omniauth-ldap.gemspec |
Commented out vcr and webmock development dependencies |
gemfiles/modular/documentation.gemfile |
Added new documentation dependencies and marked gems with require: false |
gemfiles/modular/x_std_libs/*/libs.gemfile |
Removed logger dependency from multiple Ruby version-specific gemfiles |
Gemfile.lock |
Updated dependencies including kettle-dev, removed vcr/webmock related gems |
.yardopts |
Enhanced YARD configuration with new plugins and fence support |
Documentation HTML files in docs/ |
Regenerated documentation with new YARD docs |
README.md, CHANGELOG.md, FUNDING.md, CONTRIBUTING.md |
Minor content and formatting updates |
Files not reviewed (1)
- .idea/.gitignore: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.