Merge pull request #1506 from ksss/base-file-doc

Base#file might potentially return `nil`.
lsegal · Sep 17, 2023 · 852a772 · 852a772
2 parents 698b22c + ca8f48f
commit 852a772
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/lib/yard/code_objects/base.rb b/lib/yard/code_objects/base.rb
@@ -303,6 +303,7 @@ def add_file(file, line = nil, has_comments = false)
       # definitions with docstrings first.
       #
       # @return [String] a filename
+      # @return [nil] if there is no file associated with the object
       def file
         @files.first ? @files.first[0] : nil
       end