Skip to content

doc: consistent 'Returns:'#9554

Closed
silverwind wants to merge 1 commit into
nodejs:masterfrom
silverwind:doc-returns
Closed

doc: consistent 'Returns:'#9554
silverwind wants to merge 1 commit into
nodejs:masterfrom
silverwind:doc-returns

Conversation

@silverwind
Copy link
Copy Markdown
Contributor

@silverwind silverwind commented Nov 11, 2016 •
edited
Loading

Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Description of change

We were a bit inconsistent with these. While the majority were Return: before, I think Returns: is better.
@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Nov 11, 2016
@silverwind
Copy link
Copy Markdown
Contributor Author

silverwind commented Nov 13, 2016

Thanks! Landed in 8eb19c4.
@silverwind silverwind closed this Nov 13, 2016
silverwind added a commit that referenced this pull request Nov 13, 2016
@silverwind
doc: consistent 'Returns:'
8eb19c4 
For consistency, changed all `Return:` to `Returns:` in the API docs.

PR-URL: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
addaleax pushed a commit that referenced this pull request Nov 22, 2016
@silverwind @addaleax
doc: consistent 'Returns:'
d532a57 
For consistency, changed all `Return:` to `Returns:` in the API docs.

PR-URL: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
@MylesBorins
Copy link
Copy Markdown
Contributor

MylesBorins commented Dec 13, 2016

this does not land cleanly. Would someone be willing to do a backport of the various returns work?
@silverwind
Copy link
Copy Markdown
Contributor Author

silverwind commented Dec 13, 2016

@thealphanerd it's pretty much just a

find . -type f -name "*.md" | xargs sed -i "s|Return:|Returns:|g"

Which branches should I target again? v4.x-staging and v6.x-staging?
MylesBorins added a commit to MylesBorins/node that referenced this pull request Dec 21, 2016
@MylesBorins
doc: consistent 'Returns:' part two
e10e6e3 
Follow up from 8eb19c4. Lower case `return` was not updated

Ref: nodejs#9554
@MylesBorins MylesBorins mentioned this pull request Dec 21, 2016
Closed
3 tasks
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind @MylesBorins
doc: consistent 'Returns:'
d33520c 
For consistency, changed all `Return:` to `Returns:` in the API docs.

PR-URL: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind @MylesBorins
doc: consistent 'Returns:'
d860f6e 
For consistency, changed all `Return:` to `Returns:` in the API docs.

PR-URL: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind @MylesBorins
doc: consistent 'Returns:'
c77ba8c 
For consistency, changed all `Return:` to `Returns:` in the API docs.

PR-URL: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind @MylesBorins
doc: consistent 'Returns:'
c503afc 
For consistency, changed all `Return:` to `Returns:` in the API docs.

PR-URL: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
MylesBorins pushed a commit that referenced this pull request Dec 21, 2016
@silverwind @MylesBorins
doc: consistent 'Returns:'
7fa8063 
For consistency, changed all `Return:` to `Returns:` in the API docs.

PR-URL: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
This was referenced Dec 21, 2016
Merged
Merged
MylesBorins added a commit that referenced this pull request Dec 23, 2016
@MylesBorins
doc: consistent 'Returns:' part two
0bdd39f 
Follow up from 8eb19c4. Lower case `return` was not updated

PR-URL: #10391
Ref: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
evanlucas pushed a commit that referenced this pull request Jan 3, 2017
@MylesBorins @evanlucas
doc: consistent 'Returns:' part two
ec6bddf 
Follow up from 8eb19c4. Lower case `return` was not updated

PR-URL: #10391
Ref: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
evanlucas pushed a commit that referenced this pull request Jan 4, 2017
@MylesBorins @evanlucas
doc: consistent 'Returns:' part two
4365bb4 
Follow up from 8eb19c4. Lower case `return` was not updated

PR-URL: #10391
Ref: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins added a commit that referenced this pull request Jan 23, 2017
@MylesBorins
doc: consistent 'Returns:' part two
d8fe84e 
Follow up from 8eb19c4. Lower case `return` was not updated

PR-URL: #10391
Ref: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins added a commit that referenced this pull request Jan 23, 2017
@MylesBorins
doc: consistent 'Returns:' part two
6993d1c 
Follow up from 8eb19c4. Lower case `return` was not updated

PR-URL: #10391
Ref: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins added a commit that referenced this pull request Jan 24, 2017
@MylesBorins
doc: consistent 'Returns:' part two
eef36e9 
Follow up from 8eb19c4. Lower case `return` was not updated

PR-URL: #10391
Ref: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins added a commit that referenced this pull request Jan 24, 2017
@MylesBorins
doc: consistent 'Returns:' part two
9f1b188 
Follow up from 8eb19c4. Lower case `return` was not updated

PR-URL: #10391
Ref: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins added a commit that referenced this pull request Jan 31, 2017
@MylesBorins
doc: consistent 'Returns:' part two
59aa4e9 
Follow up from 8eb19c4. Lower case `return` was not updated

PR-URL: #10391
Ref: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins added a commit that referenced this pull request Feb 1, 2017
@MylesBorins
doc: consistent 'Returns:' part two
dda777b 
Follow up from 8eb19c4. Lower case `return` was not updated

PR-URL: #10391
Ref: #9554
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Julian Duque <julianduquej@gmail.com>
Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Roman Reiss <me@silverwind.io>
Reviewed-By: James M Snell <jasnell@gmail.com>
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.

6 participants

@silverwind @MylesBorins @Fishrock123 @lpinca @cjihrig @nodejs-github-bot