Skip to content

Commit 25eda7a

Browse files
committed
Update STYLEGUIDE.md
* Fix some broken link anchors for nodejs API and move all to bottom link references * Some http to https as per OpenUserJS#915 * Some redirects resolved
1 parent a6e8f3f commit 25eda7a

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

STYLEGUIDE.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ Generally, use line comments. Save block comments for formal documentation and f
155155
**Variable and function names should be clearly descriptive of what they contain, in the context of the application**.
156156

157157
Names should be formed from the 26 upper and lower case letters *(A-Z, a-z)*, the 10 digits _(0-9)_, and the underscore *(_)*.
158-
Avoid use of international characters because they may not read well or be understood everywhere and may cause [BOM][WIKIPEDIABOM]s to appear. Do not use the dollar sign *($)* or backslash *(\)* in names.
158+
Avoid use of international characters because they may not read well or be understood everywhere and may cause [BOM][wikipediaBOM]s to appear. Do not use the dollar sign *($)* or backslash *(\)* in names.
159159

160160
Do not use an underscore *(_)* as the first character of a name. It is sometimes used to indicate privacy, but it does not actually provide privacy.
161161
If privacy is important, use the forms that provide private members. Avoid conventions that demonstrate a lack of competence.
@@ -389,7 +389,7 @@ The following **may not** be used:
389389
* `with()` *(it can be highly inconsistent)*
390390
* `Promise` *(unpredictable and considered unstable in some browser implementations at this time. Utilize callback structure with some standards of receiving `function optionalName(aArg1, aArg2, ..., aCallback)` and sending `function optionalName(aCallback, aArg1, aArg2, ...)` signatures for use with internal Code styling and async package including possible `aErr` argument parameter)*
391391

392-
Do not pass strings to `setTimeout` or `setInterval`. They use `eval()`. If you're trying to force a server side function to run asynchronously use [`setImmediate`](http://nodejs.org/api/timers.html#timers_setimmediate_callback_arg) *(or [`process.nextTick`](http://nodejs.org/api/process.html#process_process_nexttick_callback) if you really know what you're doing)*.
392+
Do not pass strings to `setTimeout` or `setInterval`. They use `eval()`. If you're trying to force a server side function to run asynchronously use [`setImmediate`][nodejsTimersSetImmediate] *(or [`process.nextTick`][nodejsProcessProcessnextTick] if you really know what you're doing)*.
393393

394394
`parseInt()` must be used with a radix parameter, e.g.,
395395
```javascript
@@ -398,11 +398,13 @@ var i = parseInt(num, 10); // base 10 - decimal system
398398

399399
Read more on the [awful parts of JavaScript][awfulparts].
400400

401-
[WIKIPEDIABOM]: http://www.wikipedia.org/wiki/Byte_order_mark
402-
[IETFRFC3629S4]: http://tools.ietf.org/html/rfc3629#section-4
403-
[awfulparts]: http://oreilly.com/javascript/excerpts/javascript-good-parts/awful-parts.html
404-
[camelcase]: http://www.wikipedia.org/wiki/CamelCase
405-
[codeconventions]: http://javascript.crockford.com/code.html
406-
[editorconfig]: http://editorconfig.org/
407-
[impliedglobals]: http://www.adequatelygood.com/Finding-Improper-JavaScript-Globals.html
408-
[typecoercion]: http://webreflection.blogspot.com/2010/10/javascript-coercion-demystified.html
401+
[nodejsProcessProcessnextTick]: https://nodejs.org/api/process.html#process_process_nexttick_callback_arg
402+
[nodejsTimersSetImmediate]: http://nodejs.org/api/timers.html#timers_setimmediate_callback_arg
403+
[wikipediaBOM]: https://www.wikipedia.org/wiki/Byte_order_mark
404+
[IETFRFC3629S4]: http://tools.ietf.org/html/rfc3629#section-4
405+
[awfulparts]: http://archive.oreilly.com/pub/a/javascript/excerpts/javascript-good-parts/awful-parts.html
406+
[camelcase]: https://www.wikipedia.org/wiki/CamelCase
407+
[codeconventions]: http://javascript.crockford.com/code.html
408+
[editorconfig]: http://editorconfig.org/
409+
[impliedglobals]: http://www.adequatelygood.com/Finding-Improper-JavaScript-Globals.html
410+
[typecoercion]: http://webreflection.blogspot.com/2010/10/javascript-coercion-demystified.html

0 commit comments

Comments
 (0)