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: add default values to function signatures in fs.md #13767

Closed

Conversation

matejkrajcovic
Copy link
Contributor

This is related to #11135

Default values I'm adding to signatures are either mentioned in descriptions in following paragraphs or are duplicated from async versions to sync.

Checklist
Affected core subsystem(s)

doc, fs

@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 Jun 18, 2017
@Trott
Copy link
Member

Trott commented Jun 18, 2017

Not something to be handled in this PR, but it looks like we do not have consistent styling for default values across our documentation. I see default = and default: and bold text vs. plain text. /cc @nodejs/documentation

@gibfahn
Copy link
Member

gibfahn commented Jun 18, 2017

@Trott good point, #13769.

This PR doesn't need to wait on that though.

Copy link
Contributor

@cjihrig cjihrig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you update the default values to match the format used in #13769.

@matejkrajcovic
Copy link
Contributor Author

@cjihrig Updated.

@@ -436,7 +436,7 @@ changes:
-->

* `path` {string|Buffer|URL}
* `mode` {integer}
* `mode` {integer} **Default:** `fs.constants.F_OK`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good to get consistency here but I would prefer something like:

Defaults to `fs.constants.F_OK`

Without the bold styling.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jasnell seems like an issue for #13769, which I had thought you were okay with.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yea, in general I'm good with improved consistency and won't block this, I just don't prefer the bold styling.

tniessen pushed a commit that referenced this pull request Jul 2, 2017
PR-URL: #13767
Refs: #11135
Refs: #13769
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@tniessen
Copy link
Member

tniessen commented Jul 2, 2017

Landed in 51bb4ac, thank you for your contribution! 🎉

@tniessen tniessen closed this Jul 2, 2017
addaleax pushed a commit to addaleax/node that referenced this pull request Jul 3, 2017
PR-URL: nodejs#13767
Refs: nodejs#11135
Refs: nodejs#13769
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@addaleax addaleax mentioned this pull request Jul 3, 2017
addaleax pushed a commit that referenced this pull request Jul 11, 2017
PR-URL: #13767
Refs: #11135
Refs: #13769
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
addaleax pushed a commit that referenced this pull request Jul 18, 2017
PR-URL: #13767
Refs: #11135
Refs: #13769
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Fishrock123 pushed a commit that referenced this pull request Jul 19, 2017
PR-URL: #13767
Refs: #11135
Refs: #13769
Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
@matejkrajcovic matejkrajcovic deleted the doc-fs-default-values branch September 5, 2017 11:15
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. 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