Make warnings consistent in the JS docs #4609

wbamberg · 2021-04-30T00:23:59Z

This is like #4504 , but for warnings.

After this PR we should have consistent markup for .warning elements in the JS docs:

all are attached to <div> elements
all contain a <p> as the first element child
the <p> contains a <strong> as the first element child
the textContent of the <strong> is "Warning:"

This ought to make it reasonably easy for the converter to turn these into "Markdown notes" as discussed in #3483.

github-actions · 2021-04-30T00:26:09Z

Preview URLs

Flaws

Note! 12 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare
Title: String.prototype.localeCompare()
on GitHub
Flaw count: 5

macros:
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator redirects to /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator/compare redirects to /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/compare
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator redirects to /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator
broken_links:
- Can't resolve /en-US/docs/Web/JavaScript/Reference/Global_Objects/Collator/Collator
bad_pre_tags:
- <pre><code>CODE can be just <pre>CODE

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split
Title: String.prototype.split()
on GitHub
Flaw count: 2

macros:
- /en-US/docs/Web/JavaScript/Reference/Operators/Comparison_Operators redirects to /en-US/docs/Web/JavaScript/Reference/Operators
broken_links:
- http:// external links are not allowed (will be forced to https:// at build-time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
Title: Error
on GitHub
Flaw count: 6

macros:
- /en-US/docs/Web/JavaScript/Reference/eval redirects to /en-US/docs/Web/JavaScript/Reference/Global_Objects/eval
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/captureStackTrace does not exist
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/description does not exist
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error/number does not exist
broken_links:
- Can't resolve /en-US/docs/Web/JavaScript/Guide/Statements#Exception_handling_statements
- http:// external links are not allowed (will be forced to https:// at build-time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join
Title: Array.prototype.join()
on GitHub
Flaw count: 1

broken_links:
- Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/__defineSetter__
Title: Object.prototype.__defineSetter__()
on GitHub
Flaw count: 1

broken_links:
- http:// external links are not allowed (will be forced to https:// at build-time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/parseInt
Title: parseInt()
on GitHub
Flaw count: 1

broken_links:
- Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
Title: Promise.prototype.catch()
on GitHub
Flaw count: 1

broken_links:
- Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Classes
Title: Classes
on GitHub
Flaw count: 2

bad_bcd_links:
- no explanation!
- no explanation!

URL: /en-US/docs/Web/JavaScript/Reference/Statements/async_function
Title: async function
on GitHub
Flaw count: 1

broken_links:
- http:// external links are not allowed (will be forced to https:// at build-time)

URL: /en-US/docs/Web/JavaScript/Reference/Statements/with
Title: with
on GitHub
Flaw count: 4

macros:
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/prototype does not exist
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/prototype does not exist
broken_links:
- Can't resolve /en-US/docs/Web/JavaScript/Reference/Functions_and_function_scope/Strict_mode
- Can't resolve /en-US/docs/Web/JavaScript/Reference/Functions_and_function_scope/Strict_mode

URL: /en-US/docs/Web/JavaScript/Reference/Operators/yield
Title: yield
on GitHub
Flaw count: 2

broken_links:
- Anchor not lowercase
- Can't resolve /en-US/docs/Web/JavaScript/Guide/The_Iterator_protocol

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer
Title: Object initializer
on GitHub
Flaw count: 2

broken_links:
- Can't resolve /en-US/docs/Glossary/primitive
- Can't resolve /en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator

URL: /en-US/docs/Web/JavaScript/Reference/Lexical_grammar
Title: Lexical grammar
on GitHub
Flaw count: 4

broken_links:
- Anchor not lowercase
- Anchor not lowercase
- http:// external links are not allowed (will be forced to https:// at build-time)
- http:// external links are not allowed (will be forced to https:// at build-time)

URL: /en-US/docs/Web/JavaScript/Reference/Functions/arguments/callee
Title: arguments.callee
on GitHub
Flaw count: 2

broken_links:
- Can't resolve /en-US/docs/JavaScript/Reference/Functions_and_function_scope/Strict_mode
- http:// external links are not allowed (will be forced to https:// at build-time)

URL: /en-US/docs/Web/JavaScript/Reference/Deprecated_and_obsolete_features/The_legacy_Iterator_protocol
Title: The legacy Iterator protocol
on GitHub
Flaw count: 2

macros:
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/StopIteration does not exist
- /en-US/docs/Web/JavaScript/Reference/Global_Objects/StopIteration does not exist

URL: /en-US/docs/Web/JavaScript/Guide/Grammar_and_types
Title: Grammar and types
on GitHub
Flaw count: 1

broken_links:
- No need for the pathname in anchor links if it's the same page

External URLs

URL: /en-US/docs/Web/JavaScript/Inheritance_and_the_prototype_chain
Title: Inheritance and the prototype chain
on GitHub

https://developers.google.com/web/tools/chrome-devtools/ (1 time)
https://docs.microsoft.com/en-us/microsoft-edge/devtools-guide (1 time)
https://repl.it/@khaled_hossain_code/prototype (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray/values
Title: TypedArray.prototype.values()
on GitHub

https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/collation
Title: Intl.Locale.prototype.collation
on GitHub

https://github.com/unicode-org/cldr/blob/2dd06669d833823e26872f249aa304bc9d9d2a90/common/bcp47/collation.xml (1 time)
https://tc39.es/ecma402/ (1 time)
https://www.unicode.org/reports/tr35/ (1 time)
https://www.unicode.org/reports/tr35/tr35-collation.html (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Locale/calendar
Title: Intl.Locale.prototype.calendar
on GitHub

https://tc39.es/ecma402/ (1 time)
https://www.unicode.org/reports/tr35/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/unescape
Title: unescape()
on GitHub

https://tc39.es/ecma262/ (1 time)
https://www.ecma-international.org/ecma-262/9.0/index.html (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/String/localeCompare
Title: String.prototype.localeCompare()
on GitHub

https://tc39.es/ecma262/ (1 time)
https://tc39.es/ecma402/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/String/split
Title: String.prototype.split()
on GitHub

https://github.com/mathiasbynens/esrever (1 time)
https://stackoverflow.com/a/34717402 (1 time)
https://tc39.es/ecma262/ (1 time)
https://unicode.org/faq/utf_bom.html (1 time)
https://unicode.org/reports/tr29/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/String/anchor
Title: String.prototype.anchor()
on GitHub

https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Error
Title: Error
on GitHub

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/escape
Title: escape()
on GitHub

https://tc39.es/ecma262/ (1 time)
https://www.ecma-international.org/ecma-262/9.0/index.html (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/join
Title: Array.prototype.join()
on GitHub

https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/values
Title: Array.prototype.values()
on GitHub

https://github.com/behnammodi/polyfill/blob/master/array.polyfill.js (1 time)
https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/__defineSetter__
Title: Object.prototype.__defineSetter__()
on GitHub

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/__defineGetter__
Title: Object.prototype.__defineGetter__()
on GitHub

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/instantiate
Title: WebAssembly.instantiate()
on GitHub

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Instance/Instance
Title: WebAssembly.Instance() constructor
on GitHub

https://webassembly.github.io/spec/js-api/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/WebAssembly/Module/Module
Title: WebAssembly.Module() constructor
on GitHub

https://webassembly.github.io/spec/js-api/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/parseInt
Title: parseInt()
on GitHub

https://en.wikipedia.org/wiki/Radix (1 time)
https://tc39.es/ecma262/ (2 times)

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
Title: Promise.prototype.catch()
on GitHub

https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Classes
Title: Classes
on GitHub

https://babeljs.io/ (1 time)
https://bugzilla.mozilla.org/show_bug.cgi?id=1428672 (1 time)
https://github.com/tc39/proposal-class-fields (2 times)
https://hacks.mozilla.org/2015/07/es6-in-depth-classes/ (1 time)
https://tc39.es (1 time)
https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Statements/async_function
Title: async function
on GitHub

https://innolitics.com/10x/javascript-decorators-for-promise-returning-functions/ (1 time)
https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Statements/with
Title: with
on GitHub

https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Operators/yield
Title: yield
on GitHub

https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Object_initializer
Title: Object initializer
on GitHub

https://github.com/tc39/proposal-object-rest-spread (1 time)
https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Lexical_grammar
Title: Lexical grammar
on GitHub

https://bugzilla.mozilla.org/show_bug.cgi?id=957513 (1 time)
https://en.wikipedia.org/wiki/Byte_order_mark (2 times)
https://en.wikipedia.org/wiki/Minification_%28programming%29 (1 time)
https://en.wikipedia.org/wiki/Newline (2 times)
https://en.wikipedia.org/wiki/Page_break (1 time)
https://en.wikipedia.org/wiki/Shebang_(Unix) (1 time)
https://en.wikipedia.org/wiki/Space_%28punctuation%29 (1 time)
https://en.wikipedia.org/wiki/Zero-width_joiner (1 time)
https://en.wikipedia.org/wiki/Zero-width_non-joiner (1 time)
https://es5.github.com/ (1 time)
https://github.com/tc39/proposal-hashbang (1 time)
https://github.com/tc39/proposal-json-superset (1 time)
https://mathiasbynens.be/notes/javascript-escapes (1 time)
https://tc39.es/ecma262/ (1 time)
https://tc39.github.io/ecma262/ (1 time)
https://whereswalden.com/2013/08/12/micro-feature-from-es6-now-in-firefox-aurora-and-nightly-binary-and-octal-numbers/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Functions/arguments/callee
Title: arguments.callee
on GitHub

https://bugzilla.mozilla.org/show_bug.cgi?id=725398 (1 time)
https://kangax.github.io/nfe/ (1 time)
https://stackoverflow.com/a/235760/578288 (1 time)
https://tc39.es/ecma262/ (1 time)

URL: /en-US/docs/Web/JavaScript/Reference/Deprecated_and_obsolete_features/The_legacy_Iterator_protocol
Title: The legacy Iterator protocol
on GitHub

No external URLs

URL: /en-US/docs/Web/JavaScript/Guide/Grammar_and_types
Title: Grammar and types
on GitHub

https://en.wikipedia.org/wiki/Grave_accent (1 time)
https://mathiasbynens.be/notes/javascript-identifiers-es6 (1 time)

* upstream/main: Fix some typos: (mdn#4620) Fix information for fullscreenchange event (mdn#4603) FF89 large ArrayBuffers (mdn#4470) fix: HTML Validation issues (mdn#4612) Make warnings consistent in the JS docs (mdn#4609) fixed typo (mdn#4617) chore(deps): bump @mdn/yari from 0.4.412 to 0.4.413 (mdn#4616) chore(deps): bump technote-space/get-diff-action from v4.0.6 to v4.1.1 (mdn#4615)

Make warnings consistent in the JS docs

a379f4a

wbamberg requested a review from a team as a code owner April 30, 2021 00:23

wbamberg requested review from Rumyra and removed request for a team April 30, 2021 00:24

Elchi3 approved these changes Apr 30, 2021

View reviewed changes

Elchi3 merged commit 9791f3a into mdn:main Apr 30, 2021

github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make warnings consistent in the JS docs #4609

Make warnings consistent in the JS docs #4609

wbamberg commented Apr 30, 2021

github-actions bot commented Apr 30, 2021

Make warnings consistent in the JS docs #4609

Make warnings consistent in the JS docs #4609

Conversation

wbamberg commented Apr 30, 2021

github-actions bot commented Apr 30, 2021

Preview URLs

Flaws

External URLs

No external URLs