doc: format try...catch consistently #28481
Conversation
| @@ -311,7 +311,7 @@ it is compiled (i.e. sometimes it may be in `./build/Debug/`), Addons can use | |||
| the [bindings][] package to load the compiled module. | |||
|
|
|||
| While the `bindings` package implementation is more sophisticated in how it | |||
| locates Addon modules, it is essentially using a try-catch pattern similar to: | |||
| locates Addon modules, it is essentially using a `try…catch` pattern similar to: | |||
There was a problem hiding this comment.
Nit: should we use 3 dots instead of ellipsis character?
There was a problem hiding this comment.
No personal preference - I just copied what was already used in the errors docs.
There was a problem hiding this comment.
I'm also fine either way, just pointed out because 3 dots are used on MDN: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/try...catch
There was a problem hiding this comment.
OK, I've replaced the ellipsis throughout the docs and tests. I didn't update the CHANGELOGS though.
There was a problem hiding this comment.
Personal opinion: 3 dots are good for code, but ellipsis really do look nicer in prose text.
There was a problem hiding this comment.
should we use 3 dots instead of ellipsis character?
Personal opinion: 3 dots are good for code, but ellipsis really do look nicer in prose text.
I don't want to get hung up on this. I think I'll just drop the second commit from this PR.
|
Leaving the ellipsis vs. three dots debate for another time. Green Lite CI: https://ci.nodejs.org/job/node-test-pull-request-lite-pipeline/3735/ |
PR-URL: nodejs#28481 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
PR-URL: #28481 Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Rich Trott <[email protected]> Reviewed-By: Ruben Bridgewater <[email protected]> Reviewed-By: Trivikram Kamat <[email protected]>
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes