doc: remove extraneous "for example" text #18890
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
BridgeAR
reviewed
Feb 21, 2018
doc/api/tls.md
Outdated
|
|
||
| For example: `{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }` | ||
| field which always contains the value `'TLSv1/SSLv3'`: | ||
| `{ name: 'AES256-SHA', version: 'TLSv1/SSLv3' }`. |
There was a problem hiding this comment.
This seems confusing to me. The former version was much clearer out of my perspective. The same applies to the part below.
doc/api/url.md
Outdated
| with the `[:{password}]` portion being optional. | ||
| referred to as _userinfo_. This string subset follows the `protocol` and | ||
| double slashes (if present) and precedes the `host` component, delimited by `@`. | ||
| The format of the string is `{username}[:{password}]`. |
There was a problem hiding this comment.
I think it is actually important to keep it the way it was. Especially for people who are not that familiar yet with the optional notation. In this specific case I would say it is hard to see that that part is meant to be "optional".
No need to announce obvious example code as being example code. Remove unneeded "for example" text as one small way to try to keep the docs more concise..
|
@BridgeAR I undid all the changes to |
lpinca
approved these changes
Feb 21, 2018
vsemozhetbyt
approved these changes
Feb 21, 2018
daynin
approved these changes
Feb 21, 2018
BridgeAR
approved these changes
Feb 21, 2018
BridgeAR
added
the
author ready
mmarchini
approved these changes
Feb 22, 2018
|
Landed in 9cb96ac 🎉 |
benjamingr
pushed a commit
that referenced
this pull request
Feb 23, 2018
No need to announce obvious example code as being example code. Remove unneeded "for example" text as one small way to try to keep the docs more concise.. PR-URL: #18890 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matheus Marchini <matheus@sthima.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
addaleax
pushed a commit
to addaleax/node
that referenced
this pull request
Feb 26, 2018
No need to announce obvious example code as being example code. Remove unneeded "for example" text as one small way to try to keep the docs more concise.. PR-URL: nodejs#18890 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matheus Marchini <matheus@sthima.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
addaleax
pushed a commit
that referenced
this pull request
Feb 26, 2018
No need to announce obvious example code as being example code. Remove unneeded "for example" text as one small way to try to keep the docs more concise.. PR-URL: #18890 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matheus Marchini <matheus@sthima.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Closed
MayaLekova
pushed a commit
to MayaLekova/node
that referenced
this pull request
May 8, 2018
No need to announce obvious example code as being example code. Remove unneeded "for example" text as one small way to try to keep the docs more concise.. PR-URL: nodejs#18890 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Matheus Marchini <matheus@sthima.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No need to announce obvious example code as being example code. Remove
unneeded "for example" text as one small way to try to keep the docs
more concise..
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passesAffected core subsystem(s)
doc