doc: added return types of functions and types of static properties #9514
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
silverwind
reviewed
Nov 11, 2016
| @@ -61,6 +61,7 @@ added: v0.1.25 | |||
|
|
|||
| * `path` {String} | |||
| * `ext` {String} An optional file extension | |||
| * Return: {String} | |||
There was a problem hiding this comment.
Should be Returns: to be consistent with other docs.
There was a problem hiding this comment.
Disregard that too, I see we're inconsistent here, will fix in another commit.
silverwind
suggested changes
Nov 11, 2016
| @@ -83,6 +84,8 @@ and is not a string. | |||
| added: v0.9.3 | |||
| --> | |||
|
|
|||
| * {String} | |||
There was a problem hiding this comment.
Maybe prefix these with Type:?
There was a problem hiding this comment.
On the other hand, people seem to be fine with it in #9505, so I guess it's okay your way.
silverwind
approved these changes
Nov 11, 2016
|
Thanks! Landed in 6cc321e. |
silverwind
pushed a commit
that referenced
this pull request
Nov 11, 2016
PR-URL: #9514 Reviewed-By: Roman Reiss <[email protected]>
addaleax
pushed a commit
that referenced
this pull request
Nov 22, 2016
PR-URL: #9514 Reviewed-By: Roman Reiss <[email protected]>
|
is this still accurate for v4 and v6? |
|
Checked on V6, can check on V4 if it needs to be done. |
MylesBorins
pushed a commit
that referenced
this pull request
Dec 21, 2016
PR-URL: #9514 Reviewed-By: Roman Reiss <[email protected]>
MylesBorins
pushed a commit
that referenced
this pull request
Dec 21, 2016
PR-URL: #9514 Reviewed-By: Roman Reiss <[email protected]>
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.
Checklist
Affected core subsystem(s)
doc
Description of change
Return types and types of static properties added to path module doc according to item