Skip to content

doc: make error descriptions more concise

Rodrigo Muino Tomonari requested to merge github/fork/Trott/used-when into master

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.

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

errors doc

Merge request reports