require-summary

[dotherightthing]

Motivation

I would like to check that each function has a summary tag to quickly understand its purpose.

Current behavior

It seems that a description tag is preferred by the validator.

Desired behavior

I would prefer to use summary unless I have sufficient supporting information to go in a description.

Alternatives considered

I could use description instead of summary. However when I change my summary tags to description tags I get validation errors.

[brettz9]

Alternatives considered

I could use description instead of summary. However when I change my summary tags to description tags I get validation errors.

@summary , as per the docs is for a shorter version of @description. @description is probably more common, and even much more common than that, is simply adding a description at the top of the block without a tag which is also acceptable.

If you want a @summary tag always present, you can use the jsdoc/require-tags rule to enforce that.

As to validation errors, you have to say which validation errors you get and under which circumstances.

[dotherightthing]

Thanks, I'll check out jsdoc/require-tags.

[brettz9]

Cool... I'll close as that should address the issue, but feel free to comment further if needed.