Skip to content

doc: fix stylistic issues in api/net.md #11786

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

doc: fix stylistic issues in api/net.md #11786

wants to merge 1 commit into from

Conversation

aqrln
Copy link
Contributor

@aqrln aqrln commented Mar 10, 2017 •
edited
Loading

  • Change var to const in an example of server creation.
  • Add missing semicolons.
  • Use console syntax highlighting instead of js in the nc command invocation example and add a shell prompt symbol to be consistent with the rest of the documentation.
Checklist
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem. labels Mar 10, 2017
@aqrln aqrln force-pushed the doc-net-stylefixes branch from 246ca56 to 17e24be Compare March 10, 2017 10:39
@aqrln
Copy link
Contributor Author

aqrln commented Mar 10, 2017

Hmm, I omitted that telnet example somehow 😅 Though it used rather correct "sh" highlighting, I changed that to "console" too since it seems to be more common in the docs (23 "console" blocks versus 13 "sh" and "shell" ones together currently in master).

@lpinca I've pushed a new commit, PTAL.

@lpinca
Copy link
Member

lpinca commented Mar 10, 2017

Still LGTM.

@aqrln
doc: fix stylistic issues in api/net.md
7077363 
* Change var to const in an example of server creation.
* Add missing semicolons.
* Use `console` syntax highlighting in `telnet` and `nc` invocation
  examples and add shell prompt symbols to be consistent with the rest
  of the documentation.
@aqrln aqrln force-pushed the doc-net-stylefixes branch from 17e24be to 7077363 Compare March 11, 2017 23:37
@aqrln
Copy link
Contributor Author

aqrln commented Mar 11, 2017

Rebased and resolved conflicts.

@joyeecheung
Copy link
Member

Landed in d3418b1, thanks!

joyeecheung pushed a commit that referenced this pull request Mar 14, 2017
@aqrln @joyeecheung
doc: fix stylistic issues in api/net.md
d3418b1 
* Change var to const in an example of server creation.
* Add missing semicolons.
* Use `console` syntax highlighting in `telnet` and `nc` invocation
  examples and add shell prompt symbols to be consistent with the rest
  of the documentation.

PR-URL: #11786
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@aqrln aqrln deleted the doc-net-stylefixes branch March 14, 2017 17:26
jungx098 pushed a commit to jungx098/node that referenced this pull request Mar 21, 2017
@aqrln @jungx098
doc: fix stylistic issues in api/net.md
9af5ce2 
* Change var to const in an example of server creation.
* Add missing semicolons.
* Use `console` syntax highlighting in `telnet` and `nc` invocation
  examples and add shell prompt symbols to be consistent with the rest
  of the documentation.

PR-URL: nodejs#11786
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@italoacasas
Copy link
Contributor

This PR need backport to v7

@aqrln
Copy link
Contributor Author

aqrln commented Mar 21, 2017

@italoacasas, np, will do it later today.

aqrln added a commit to aqrln/node that referenced this pull request Mar 21, 2017
@aqrln
doc: fix stylistic issues in api/net.md
e9d6efa 
* Change var to const in an example of server creation.
* Add missing semicolons.
* Use `console` syntax highlighting in `telnet` and `nc` invocation
  examples and add shell prompt symbols to be consistent with the rest
  of the documentation.

PR-URL: nodejs#11786
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@aqrln aqrln mentioned this pull request Mar 21, 2017
Closed
2 tasks
@aqrln aqrln mentioned this pull request Mar 21, 2017
Closed
2 tasks
aqrln added a commit to aqrln/node that referenced this pull request Mar 22, 2017
@aqrln
doc: fix stylistic issues in api/net.md
461421b 
* Change var to const in an example of server creation.
* Add missing semicolons.
* Use `console` syntax highlighting in `telnet` and `nc` invocation
  examples and add shell prompt symbols to be consistent with the rest
  of the documentation.

PR-URL: nodejs#11786
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@jasnell jasnell mentioned this pull request Apr 4, 2017
Closed
MylesBorins pushed a commit that referenced this pull request Apr 13, 2017
@aqrln @MylesBorins
doc: fix stylistic issues in api/net.md
7e98f23 
* Change var to const in an example of server creation.
* Add missing semicolons.
* Use `console` syntax highlighting in `telnet` and `nc` invocation
  examples and add shell prompt symbols to be consistent with the rest
  of the documentation.

Backport-PR-URL: #11969
PR-URL: #11786
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Apr 19, 2017
@aqrln @MylesBorins
doc: fix stylistic issues in api/net.md
1604848 
* Change var to const in an example of server creation.
* Add missing semicolons.
* Use `console` syntax highlighting in `telnet` and `nc` invocation
  examples and add shell prompt symbols to be consistent with the rest
  of the documentation.

Backport-PR-URL: #11969
PR-URL: #11786
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Apr 19, 2017
Merged
@evanlucas evanlucas mentioned this pull request May 1, 2017
Merged
evanlucas pushed a commit that referenced this pull request May 1, 2017
@aqrln @evanlucas
doc: fix stylistic issues in api/net.md
b1d3f59 
* Change var to const in an example of server creation.
* Add missing semicolons.
* Use `console` syntax highlighting in `telnet` and `nc` invocation
  examples and add shell prompt symbols to be consistent with the rest
  of the documentation.

PR-URL: #11786
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
andrew749 pushed a commit to michielbaird/node that referenced this pull request Jul 19, 2017
@aqrln @andrew749
doc: fix stylistic issues in api/net.md
3a35927 
* Change var to const in an example of server creation.
* Add missing semicolons.
* Use `console` syntax highlighting in `telnet` and `nc` invocation
  examples and add shell prompt symbols to be consistent with the rest
  of the documentation.

Backport-PR-URL: nodejs/node#11969
PR-URL: nodejs/node#11786
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: James M Snell <jasnell@gmail.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Reviewers

@jasnell jasnell jasnell approved these changes

@addaleax addaleax addaleax approved these changes

@lpinca lpinca lpinca approved these changes

@cjihrig cjihrig cjihrig approved these changes

@joyeecheung joyeecheung joyeecheung approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. net Issues and PRs related to the net subsystem.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
9 participants
@aqrln @lpinca @joyeecheung @italoacasas @jasnell @addaleax @cjihrig @evanlucas @nodejs-github-bot