oxc-project / oxc

⚓ A collection of JavaScript tools written in Rust.
https://oxc.rs
MIT License
12.57k stars 459 forks source link

Improve linter rules documentation #6050

Open shulaoda opened 2 months ago

shulaoda commented 2 months ago

Description

We have currently adopted a new document template, and some rules need to be supplemented and aligned again.

/// ### What it does
///
/// ### Why is this bad?
///
/// ### Examples
///
/// Examples of **incorrect** code for this rule:
///
/// Examples of **correct** code for this rule:

Currently, some known rules have the following issues:

Task lists

DonIsaac commented 2 months ago

@shulaoda is this a comprehensive list or are there more areas you want to document?

shulaoda commented 2 months ago

@shulaoda is this a comprehensive list or are there more areas you want to document?

This is not comprehensive, I will gradually supplement it. I will list the areas involved later.

DonIsaac commented 2 months ago

@shulaoda I don't love having a running issue like this open without clear goals, so I'm going to close this as complete. When you find other areas you want to document, feel free to open a new issue with those areas listed in the description.

shulaoda commented 2 months ago

@shulaoda I don't love having a running issue like this open without clear goals, so I'm going to close this as complete. When you find other areas you want to document, feel free to open a new issue with those areas listed in the description.

Apologies for that, my bad. I should have provided a clear description from the beginning. Could you reopened the issue?