doc: make node(1) more consistent with tradition#8902
Uh oh!
There was an error while loading. Please reload this page.
Conversation
bnoordhuis commented Oct 3, 2016
The "has many bugs" in the BUGS section is too nondescript to be useful, I'd change it to a REPORTING BUGS section with a link to the bug tracker. I personally don't care for an AUTHORS section; it's not very relevant to readers and in our case it's misleading because Ryan hasn't worked on node for something like four years now. Suggestion: a LICENSE section might be a good addition. |
doc/node.1 Outdated
Fishrock123 commented Oct 3, 2016
I don't agree with the |
doc/node.1 Outdated
There was a problem hiding this comment.
Effectively written by many others too. I would just link to the AUTHORS.
doc/node.1 Outdated
There was a problem hiding this comment.
same, maybe just link the issue tracker? it's also linked below though....
imo, just remove
strugee commented Oct 3, 2016
@bnoordhuis@Fishrock123 changed the wording of the BUGS section to be more concise. If people still disagree with this I can just remove it entirely I also changed AUTHORS to not mention Ryan, got rid of the |
doc/node.1 Outdated
There was a problem hiding this comment.
Sorry, I meant not to touch these at all.
I know it's not "perfectly syntactically correct" but it is far more readable.
In my experience the problems with rendering are negligible if any for the potential cost of people having a hard time contributing.
doc/node.1 Outdated
There was a problem hiding this comment.
Add spaces between please (see above note)
doc/node.1 Outdated
There was a problem hiding this comment.
I don't think this correct -- all rights are not reserved, it is licensed under MIT.
There was a problem hiding this comment.
Honestly, I thought so too. But that's what LICENSE says. Does that need to be changed too?
There was a problem hiding this comment.
@Fishrock123 changed this despite the inconsistency with LICENSE.
doc/node.1 Outdated
There was a problem hiding this comment.
I think the previous wording is more obvious.
strugee commented Oct 4, 2016
All issues fixed, including the "All rights reserved" section (even though it's inconsistent with LICENSE). |
jasnell left a comment
jasnell left a comment There was a problem hiding this comment.
Couple of nits I'd like to see fixed up but otherwise LGTM
doc/node.1 Outdated
doc/node.1 Outdated
There was a problem hiding this comment.
Nit: Given that #node.js is not yet considered an official resource managed by the project, a note indicating it's unofficial status might be worthwhile.
doc/node.1 Outdated
There was a problem hiding this comment.
could please add spaces here? looks good other than that
strugee commented Oct 6, 2016
👍 all issues fixed; this is ready to merge |
doc/node.1 Outdated
There was a problem hiding this comment.
nit: long line here. could be fixed when landing.
* Added traditional BUGS, AUTHORS and COPYRIGHT sections * Fixed some minor issues with the IRC links
* Added traditional BUGS, AUTHORS and COPYRIGHT sections * Fixed some minor issues with the IRC links PR-URL: #8902 Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: James M Snell <[email protected]>
jasnell commented Oct 8, 2016
Landed in 90cd39f. Thank you! |
strugee commented Oct 8, 2016
Thanks very much! 👍 |
* Added traditional BUGS, AUTHORS and COPYRIGHT sections * Fixed some minor issues with the IRC links PR-URL: #8902 Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: James M Snell <[email protected]>
* Added traditional BUGS, AUTHORS and COPYRIGHT sections * Fixed some minor issues with the IRC links PR-URL: #8902 Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: James M Snell <[email protected]>
* Added traditional BUGS, AUTHORS and COPYRIGHT sections * Fixed some minor issues with the IRC links PR-URL: #8902 Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: James M Snell <[email protected]>
7 participants
Checklist
Affected core subsystem(s)
doc
Description of change
In particular I'm not sure if everyone will be cool with the BUGS text - I personally think it's good but if anyone disagrees I'm not super attached to it. Also, I put
.\"s instead of outright removing the newlines because I think it's (slightly) more readable, but I can also get rid of those.