doc: add default values to function signatures in fs.md #13767
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
doc
|
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 |
Refs: nodejs#13769 New style is introduced in PR nodejs#13769.
|
@cjihrig Updated. |
cjihrig
approved these changes
Jun 20, 2017
gibfahn
approved these changes
Jun 20, 2017
jasnell
reviewed
Jun 20, 2017
| @@ -436,7 +436,7 @@ changes: | |||
| --> | |||
|
|
|||
| * `path` {string|Buffer|URL} | |||
| * `mode` {integer} | |||
| * `mode` {integer} **Default:** `fs.constants.F_OK` | |||
There was a problem hiding this comment.
It's good to get consistency here but I would prefer something like:
Defaults to `fs.constants.F_OK`
Without the bold styling.
There was a problem hiding this comment.
Yea, in general I'm good with improved consistency and won't block this, I just don't prefer the bold styling.
3 tasks
|
Landed in 51bb4ac, thank you for your contribution! 🎉 |
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>
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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