yard icon indicating copy to clipboard operation
yard copied to clipboard

Conflicting docs for @attr et al

Open p-mongo opened this issue 6 years ago • 1 comments

On https://www.rubydoc.info/gems/yard/file/docs/Tags.md#attr, the docs for @attr are:

 @attr name [Types] description 

However the example given is:

# @attr [String] name the name of the structure

The name and the types are inverted.

p-mongo avatar Jun 18 '19 19:06 p-mongo

This should be fixed to be consistent but just FYI both syntaxes are supported, so it's not exactly conflicting.

lsegal avatar Jun 28 '19 02:06 lsegal