Merge pull request #16906 from dduugg/yard-rbi

Include .rbi shims in yard docs
Homebrew · Mar 18, 2024 · af8b105 · af8b105
2 parents 2bb5344 + 9f63674
commit af8b105
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/Library/Homebrew/.yardopts b/Library/Homebrew/.yardopts
@@ -5,10 +5,12 @@
 --plugin sorbet
 --load yard/ignore_directives.rb
 --template-path yard/templates
+--exclude sorbet/rbi/gems/
 --exclude test/
 --exclude vendor/
 --exclude yard/
 extend/os/**/*.rb
 **/*.rb
+**/*.rbi
 -
 *.md
diff --git a/Library/Homebrew/extend/hash/deep_transform_values.rb b/Library/Homebrew/extend/hash/deep_transform_values.rb
@@ -6,6 +6,7 @@ class Hash
   # This includes the values from the root hash and from all
   # nested hashes and arrays.
   #
+  # @example
   #  hash = { person: { name: 'Rob', age: '28' } }
   #
   #  hash.deep_transform_values{ |value| value.to_s.upcase }