Uh oh!
There was an error while loading. Please reload this page.
Doc: remove non-standard use of hyphens in doc/api/tls.markdown - #5677
Doc: remove non-standard use of hyphens in doc/api/tls.markdown#5677svozza wants to merge 1 commit into
Conversation
claudiorodriguez
commented
Mar 12, 2016
LGTM. I think it might be a good idea to clarify this on the style guide (https://github.com/nodejs/docs/blob/master/STYLE-GUIDE.md), gonna make an issue there. |
47c87c0 to
816092bComparesvozza
commented
Mar 12, 2016
Ah, I didn't see the style guide, very handy. I've just updated the PR to remove all occurrences of the word 'you' in light of that document. |
816092b to
e880edaCompareeljefedelrodeodeljefe
commented
Mar 12, 2016
This PR has more than just the described changes in it. Can you exclude them please? Also the use of |
9c062f5 to
202b99fComparesvozza
commented
Mar 12, 2016
Sure thing. Can I open a separate PR with the other changes? I think the document reads much better than before. |
eljefedelrodeodeljefe
commented
Mar 12, 2016
Sure, generally. Just two remarks here. Not every hyphen qualifies for removal. Those behind acronyms especially, since those seem quite consistent to the rest of the docs. If there is something wrong in general in english or style, I'd rather suggest opening an issue at nodejs/docs. Second, while I agree on the hyphens seemingly being misplaced and hence having inferior readability of the doc, you probably have to make a good case for the other changes. But please, PR is always welcome. We discuss it there. |
svozza
commented
Mar 12, 2016
Do you mean 'in front of'? E.g., the ALPN/NPN and SNI ones? Aside from the personal pronoun stuff, which I will omit from the PR, I think the other changes are pretty uncontroversial, they're mainly just fixing typos and missing definite/indefinite articles. |
eljefedelrodeodeljefe
commented
Mar 12, 2016
Yes, I mean those. Sure, they are. They are also a bit of a nit, the WG might want to have in a broader effort. Those kind of problems are all over the docs, I mean. We'll see... |
jasnell
commented
Mar 12, 2016
LGTM |
svozza
commented
Mar 12, 2016
Cool. I'll change back those other hyphens. |
202b99f to
f6c58c3CompareTrott
commented
Mar 13, 2016
Nit: Can you add |
f6c58c3 to
b353bb9Comparesvozza
commented
Mar 13, 2016
No problem, all done. |
eljefedelrodeodeljefe
commented
Mar 13, 2016
LGTM |
b353bb9 to
c020201CompareIdentifies the non-idiomatic usages of the '-' character and either removes them or replaces them with colons. Fixes: nodejs#5672
c020201 to
9ad2ebdComparejasnell
commented
Mar 14, 2016
Landed in ecbb955 |
Affected core subsystem(s)
Doc, TLS
Description of change
Fixes#5672. Removes the non-idiomatic usages of the '-' character.
I also tidied up some of the phrasing, grammar, typos and punctuation throughout the whole file. If I should have done this in a separate PR, I'm happy to pull them out and leave only the hyphen changes.Also, there seems to be an inconsistent use of 'can', 'could' and 'may' throughout the document but I decided against changing that as I don't really know what the house style is.