doc: make comment indentation consistent#9518
Uh oh!
There was an error while loading. Please reload this page.
Conversation
nodejs-github-bot added console 
silverwind commented Nov 9, 2016
Looking good from my side, but did you check other doc files that this is the only case of such comments? I think there ought to be more similar cases. |
danbev commented Nov 9, 2016
I'd be happy to go the through the rest, but before I do are people happy onsdag 9 november 2016 skrev silverwind [email protected]:
|
silverwind commented Nov 9, 2016
@nodejs/collaborators any preferences for style of indentation in code samples? I personally prefer the non-indented version. |
mscdex commented Nov 9, 2016
IMHO the comments should be above the line it's referring to and unindented. |
silverwind commented Nov 9, 2016
I generally agree, but think an exception for stdout could be made. Some people use this style for those: console.log('hello world');//=> hello world |
targos commented Nov 9, 2016
Unindented comments LGTM. |
gibfahn commented Nov 9, 2016
Comments look good unindented +1 for above the line, I get the argument for having stdout below, but I think it's less clear. |
silverwind left a comment
silverwind left a comment There was a problem hiding this comment.
LGTM, nice work. I prefer the comment-after-code style because it's what one would see in the REPL. Let's see if we get a few more approvals.
danbevforce-pushed the consistent-indent-of-comments branch from 80e2d81 to 6a1f03cComparedanbev commented Nov 15, 2016
danbev commented Nov 15, 2016
I'd like to merge this later today if there are no objections. |
Currently, console.md use different indentation for comments in the code examples. This commit makes the indentation consistent by putting the comments at the beginning of the line (really no indentation that is). I was not sure what is preferred but hopefully comments on the PR will provide guidance..
danbevforce-pushed the consistent-indent-of-comments branch from 6a1f03c to 867dedaCompareCurrently, some of the docs use different indentation for comments in the code examples. This commit makes the indentation consistent by putting the comments at the beginning of the line (really no indentation that is). PR-URL: nodejs#9518 Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
danbev commented Nov 16, 2016
Landed in 367065b |
Currently, some of the docs use different indentation for comments in the code examples. This commit makes the indentation consistent by putting the comments at the beginning of the line (really no indentation that is). PR-URL: #9518 Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
Currently, some of the docs use different indentation for comments in the code examples. This commit makes the indentation consistent by putting the comments at the beginning of the line (really no indentation that is). PR-URL: #9518 Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
Currently, some of the docs use different indentation for comments in the code examples. This commit makes the indentation consistent by putting the comments at the beginning of the line (really no indentation that is). PR-URL: #9518 Reviewed-By: Teddy Katz <[email protected]> Reviewed-By: Roman Reiss <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
8 participants
Checklist
make -j8 test(UNIX), orvcbuild test nosign(Windows) passesAffected core subsystem(s)
doc
Description of change
Currently, console.md use different indentation for comments in the code
examples. This commit makes the indentation consistent by putting the
comments at the beginning of the line (really no indentation that is). I
was not sure what is preferred but hopefully comments on the PR will
provide guidance..