Wrong documentation for order-dependent lists.

[frsantos]

The documentation for order-dependent lists (a.k.a tuples), is misleading, as it says to use Array<(String, Fixnum, Hash)>, when that is a mixed of long and short syntax, which is interpreted differently.

yard/docs/Tags.md

Lines 206 to 209 in 2d197a3

	An order dependent list is a set of types surrounded by "()" and separated by
	commas. This list must contain exactly those types in exactly the order specified.
	For instance, an Array containing a String, Fixnum and Hash in that order (and
	having exactly those 3 elements) would be listed as: `Array<(String, Fixnum, Hash)>`.

Steps to reproduce

Use the explain_types on a param tag

::YARD::DocstringParser.new.parse("@param [Array<(Date, Integer)>]").tags.first.explain_types

Actual Output

::YARD::DocstringParser.new.parse("@param [Array<(Date, Integer)>]").tags.first.explain_types
=> "an Array of (an Array containing (a Date followed by an Integer))"

Expected Output

# Long syntax
::YARD::DocstringParser.new.parse("@param [Array(Date, Integer)]").tags.first.explain_types
=> "an Array containing (a Date followed by an Integer)"

# Short syntax
::YARD::DocstringParser.new.parse("@param [(Date, Integer)]").tags.first.explain_types
=> "an Array containing (a Date followed by an Integer)"

Environment details:

• OS: Ubuntu 23.10
• Ruby version (ruby -v): ruby 3.0.6p216 (2023-03-30 revision 23a532679b) [x86_64-linux]
• YARD version (yard -v): yard 0.9.34
• Relevant software dependency/versions:

I have read the Contributing Guide.

[frsantos]

I created a PR for the docs.