Skip to content

[v8.x backport] doc: make error descriptions more concise

Rodrigo Muino Tomonari requested to merge github/fork/Trott/backport-16954-v8 into v8.x-staging

Backport of https://github.com/nodejs/node/pull/16954

Remove the practice of starting most error descriptions with "Used when" or wordier variations.

Change errors of the form:

Used when the type of an asynchronous resource is invalid.

...to:

The type of an asynchronous resource was invalid.

Change errors of the form:

The 'ERR_INVALID_CURSOR_POS' is thrown specifically when a cursor on a given stream is attempted to move to a specified row without a specified column.

...to:

A cursor on a given stream cannot be moved to a specified row without a specified column.

PR-URL: https://github.com/nodejs/node/pull/16954 Reviewed-By: James M Snell jasnell@gmail.com Reviewed-By: Gireesh Punathil gpunathi@in.ibm.com Reviewed-By: Benjamin Gruenbaum benjamingr@gmail.com Reviewed-By: Tobias Nießen tniessen@tnie.de Reviewed-By: Joyee Cheung joyeec9h3@gmail.com

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc errors

Merge request reports