eslint-plugin-promise icon indicating copy to clipboard operation
eslint-plugin-promise copied to clipboard

There is no documentation for some rules

Open MansurAliKoroglu opened this issue 4 years ago • 3 comments
trafficstars

Description

Four of the rules has no documentation.

Steps to Reproduce

  1. Visit the links:
  • https://github.com/xjamundx/eslint-plugin-promise/blob/HEAD/docs/rules/no-promise-in-callback.md
  • https://github.com/xjamundx/eslint-plugin-promise/blob/HEAD/docs/rules/no-callback-in-promise.md
  • https://github.com/xjamundx/eslint-plugin-promise/blob/HEAD/docs/rules/avoid-new.md
  • https://github.com/xjamundx/eslint-plugin-promise/blob/HEAD/docs/rules/prefer-await-to-callbacks.md

MansurAliKoroglu avatar Apr 30 '21 21:04 MansurAliKoroglu

Partially addressed in #215

xjamundx avatar Oct 21 '21 05:10 xjamundx

Related discussion about the reasons for avoid-new: https://github.com/eslint-community/eslint-plugin-promise/issues/111

DerZyklop avatar Oct 19 '22 12:10 DerZyklop

I agree that rules should be documented.

DamienCassou avatar Jan 30 '24 16:01 DamienCassou