8000 Docs: `ban-ts-comment` is missing description of a new `descriptionFormat` option · Issue #5282 · typescript-eslint/typescript-eslint · GitHub
[go: up one dir, main page]
Skip to content
Docs: ban-ts-comment is missing description of a new descriptionFormat option #5282
New issue
New issue
Closed
#5283
Closed
Docs: ban-ts-comment is missing description of a new descriptionFormat option#5282
#5283
Labels
accepting prsGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updating
@dzek69

Description

@dzek69
dzek69
opened on Jul 1, 2022

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

Suggested Changes

This PR #5026 adds a support for new descriptionFormat option for ban-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

Metadata

Metadata

Assignees

No one assigned

    Labels

    accepting prsGo ahead, send a pull request that resolves this issuedocumentationDocumentation ("docs") that needs adding/updating

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions
      0