Skip to content

doc: add missing type=misc top comments

Rodrigo Muino Tomonari requested to merge github/fork/vsemozhetbyt/type-misc into master
Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

If I get this right, we have two types of docs: concerning require-able modules and other docs.

Other docs usually have top level <!-- type=misc --> comments, so that the top JSON container for them would be miscs (compare a require-able module doc). These docs adhere this rule:

  • cli.md
  • debugger.md
  • documentation.md
  • errors.md
  • globals.md
  • synopsis.md

These ones seem to lack these comments:

  • addons.md
  • deprecations.md
  • esm.md
  • intl.md
  • n-api.md

addons, esm, and n-api docs concern importable modules, but they are mostly tutorials, not module API docs. I may be wrong in these cases, so correct me if so.

As for tracing.md, it will become a require-able module doc soon, so the mentioned comment is not needed there now.

Merge request reports