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

doc: fix arg definition in fs #18678

Closed
wants to merge 1 commit into from

Conversation

apapirovski
Copy link
Member

@apapirovski apapirovski commented Feb 9, 2018

Currently doc building doesn't support ES-style default params in
function definitions which causes a warning.

Here is the error:

Warning: invalid param "len "
 > {"textRaw":"`len` {integer} **Default:** `0` ","name":"len","type":"integer","desc":"**Default:** `0`"}
 > filehandle.truncate(len = 0)
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

Currently doc building doesn't support ES-style default params in
function definitions which causes an error.
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Feb 9, 2018
@apapirovski
Copy link
Member Author

@BridgeAR BridgeAR added fast-track PRs that do not need to wait for 48 hours to land. author ready PRs that have at least one approval, no pending requests for changes, and a CI started. labels Feb 9, 2018
@apapirovski
Copy link
Member Author

Thanks everyone! Landed in dbd1d1d

@apapirovski apapirovski closed this Feb 9, 2018
@apapirovski apapirovski deleted the fix-fs-doc branch February 9, 2018 16:29
apapirovski added a commit that referenced this pull request Feb 9, 2018
Currently doc building doesn't support ES-style default params in
function definitions which causes an error.

PR-URL: #18678
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Gus Caplan <me@gus.host>
@MylesBorins
Copy link
Contributor

Should this be backported to v9.x-staging? If yes please follow the guide and raise a backport PR, if not let me know or add the dont-land-on label.

@targos
Copy link
Member

targos commented Mar 24, 2018

This depends on #18297 which won't land on older branches.

@targos targos added dont-land-on-v4.x and removed author ready PRs that have at least one approval, no pending requests for changes, and a CI started. backport-requested-v9.x labels Mar 24, 2018
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
Currently doc building doesn't support ES-style default params in
function definitions which causes an error.

PR-URL: nodejs#18678
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Gus Caplan <me@gus.host>
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. fast-track PRs that do not need to wait for 48 hours to land. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants