Before You File a Documentation Request Please Confirm You Have Done The Following...

• I have looked for existingopen or closed documentation requests that match my proposal.
• I haveread the FAQ and my problem is not listed.

Suggested Changes

This PR#5026 adds a support for newdescriptionFormat option forban-ts-comment.

@Josh-Cena had written:

I personally don't like this API design a lot, so I'd like to get settled on the API before writing docs.

But finally the PR got merged without any docs and a month has passed without docs update, so I guess it just a forgotten thing now. So I'm leaving this issue as an reminder.

Affected URL(s)

https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/docs/rules/ban-ts-comment.md