Attr_accessor documentation of @param broke in 436fae5

[now]

The changes introduced in 436fae5 messed up the following:

# @param [String] value
# @return [String] The string’s value
attr_accessor :string

as attr_accessor’s reader won’t have a parameter. This should really be fixed, either by reverting 436fae5 (and erring on the side of not generating spurious warnings) or by adjusting the code in AttributeHandler to first add the parameters before the call to #register, then removing them (which will appease the check and still generate a correct result).

What do you think?

[lsegal]

That isn't valid documentation; YARD is correct to warn you here. When documenting an attr_accessor, you should be documenting the getter portion, i.e., only the @return tag. YARD will typically fill in the setter for you, but if you want your own setter documentation, you should use an @overload tag instead:

# @overload string
#   @return [String] the string's value
# @overload string=(value)
#   @param value [String] the value to set
attr_accessor :string

This isn't well documented, unfortunately, so I understand the confusion. Documenting attrs should have their own callout in the guide.

[lsegal]

I have some documentation improvements coming in the guide for this.

[now]

OK, thanks. As using @Overloads felt a bit verbose, I create the missing @param tag programmatically in my template for attribute writers instead.