Skip to content

Commit

Permalink
Fix annotation in CodeObjects::Base#files
Browse files Browse the repository at this point in the history
The original annotation incorrectly was Array<String> but the format is

```
[ [file, line] ]
```

Therefore the annotation should be `Array<Array<String, Integer>>`,
given there is no prescribed way to describe tuples
  • Loading branch information
gmalette committed Jul 20, 2018
1 parent 8a0e6ac commit fa97a25
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion lib/yard/code_objects/base.rb
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ def push(value)
# @see NamespaceMapper.register_separator
class Base
# The files the object was defined in. To add a file, use {#add_file}.
# @return [Array<String>] a list of files
# @return [Array<Array<String, Integer>>] a list of files
# @see #add_file
attr_reader :files

Expand Down

0 comments on commit fa97a25

Please sign in to comment.