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: added return types of functions and types of static properties #9514

Conversation

imatveev
Copy link
Contributor

@imatveev imatveev commented Nov 8, 2016

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

Description of change

Return types and types of static properties added to path module doc according to item

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. path Issues and PRs related to the path subsystem. labels Nov 8, 2016
@@ -61,6 +61,7 @@ added: v0.1.25

* `path` {String}
* `ext` {String} An optional file extension
* Return: {String}
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be Returns: to be consistent with other docs.

Copy link
Contributor

Choose a reason for hiding this comment

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

Disregard that too, I see we're inconsistent here, will fix in another commit.

@@ -83,6 +84,8 @@ and is not a string.
added: v0.9.3
-->

* {String}
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe prefix these with Type:?

Copy link
Contributor

Choose a reason for hiding this comment

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

On the other hand, people seem to be fine with it in #9505, so I guess it's okay your way.

@silverwind
Copy link
Contributor

Thanks! Landed in 6cc321e.

@silverwind silverwind closed this Nov 11, 2016
silverwind pushed a commit that referenced this pull request Nov 11, 2016
PR-URL: #9514
Reviewed-By: Roman Reiss <me@silverwind.io>
addaleax pushed a commit that referenced this pull request Nov 22, 2016
PR-URL: #9514
Reviewed-By: Roman Reiss <me@silverwind.io>
@MylesBorins
Copy link
Contributor

is this still accurate for v4 and v6?

@imatveev
Copy link
Contributor Author

Checked on V6, can check on V4 if it needs to be done.

@imatveev imatveev deleted the doc-path-properties-functions-return-types branch December 15, 2016 22:26
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
PR-URL: #9514
Reviewed-By: Roman Reiss <me@silverwind.io>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
PR-URL: #9514
Reviewed-By: Roman Reiss <me@silverwind.io>
@MylesBorins MylesBorins mentioned this pull request Dec 21, 2016
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. path Issues and PRs related to the path subsystem.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants