Skip to content

change the way the arguments are defined in the doc #14621

@dcharbonnier

Description

@dcharbonnier

The documentation does not reflect correctly the types of the arguments, an argument that can be null or undefined should not be defined as "integer" https://github.com/nodejs/node/pull/14612/files#r131284818
This comment is an example but all the documentation is like that, this require to be changed everywhere or it will be confusing, for now it's implicit but if we change it at one place we should change it everywhere.
We probably need to think about an easy and constant way to present the arguments types in the documentation, the way typescript do it could be a solution. position?: integer|null
Thx @sam-github to point this problem in the documentation.

Metadata

Metadata

Assignees

No one assigned

    Labels

    docIssues and PRs related to the documentations.stalledIssues and PRs that are stalled.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions