From fa97a25cbd0440768c70becd8ffa290a1b4ed02f Mon Sep 17 00:00:00 2001 From: Guillaume Malette Date: Fri, 20 Jul 2018 11:43:23 -0400 Subject: [PATCH 1/2] Fix annotation in CodeObjects::Base#files The original annotation incorrectly was Array but the format is ``` [ [file, line] ] ``` Therefore the annotation should be `Array>`, given there is no prescribed way to describe tuples --- lib/yard/code_objects/base.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/yard/code_objects/base.rb b/lib/yard/code_objects/base.rb index cf517ace1..afd697cee 100644 --- a/lib/yard/code_objects/base.rb +++ b/lib/yard/code_objects/base.rb @@ -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] a list of files + # @return [Array>] a list of files # @see #add_file attr_reader :files From 465e1f96aa46ebee0ab313cd7087634c5e69a2f9 Mon Sep 17 00:00:00 2001 From: Guillaume Malette Date: Sat, 21 Jul 2018 12:03:20 -0400 Subject: [PATCH 2/2] Use the proper annotation for tuples --- lib/yard/code_objects/base.rb | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/yard/code_objects/base.rb b/lib/yard/code_objects/base.rb index afd697cee..5f5931e52 100644 --- a/lib/yard/code_objects/base.rb +++ b/lib/yard/code_objects/base.rb @@ -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>] a list of files + # @return [Array] a list of files # @see #add_file attr_reader :files