Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
dcharbonnier opened this issue Aug 4, 2017 · 2 comments
Closed

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

dcharbonnier opened this issue Aug 4, 2017 · 2 comments
Labels
doc Issues and PRs related to the documentations. stalled Issues and PRs that are stalled.

Comments

@dcharbonnier
Copy link
Contributor

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.

@Trott
Copy link
Member

Trott commented Aug 4, 2017

@nodejs/documentation

@mscdex mscdex added the doc Issues and PRs related to the documentations. label Aug 4, 2017
@jasnell
Copy link
Member

jasnell commented Aug 12, 2018

There's been zero activity on this in over a year, I recommend closing.

@jasnell jasnell added the stalled Issues and PRs that are stalled. label Aug 12, 2018
@jasnell jasnell closed this as completed Oct 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations. stalled Issues and PRs that are stalled.
Projects
None yet
Development

No branches or pull requests

4 participants