Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix broken dd elements in JS docs #4625

Merged
merged 3 commits into from
Apr 30, 2021
Merged

Conversation

wbamberg
Copy link
Collaborator

This PR aims to fix all the places in the JS docs that are incorrectly using multiple <dd> elements when they want to include multiple block elements in a single <dd>, as noted in #4367 (comment).

I'm guessing this is coming from the WYSIWYG editor in the old Wiki, where IIRC it was easy to add new <dd> elements by mistake.

There are no places in the JS docs where the author really wanted to use multiple <dd> elements as far as I can see. So I think we might want to automate a mass-conversion of these across all our docs. It wasn't too bad doing it by hand, but it's easy to make mistakes.

Will added 3 commits April 29, 2021 21:40
* 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)
@wbamberg wbamberg requested a review from a team as a code owner April 30, 2021 15:01
@wbamberg wbamberg requested review from sideshowbarker and removed request for a team April 30, 2021 15:01
@github-actions
Copy link
Contributor

Preview URLs

Flaws

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

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

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat
Title: Intl.DateTimeFormat() constructor
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/RegExp/RegExp
Title: RegExp() constructor
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

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

  • broken_links:
    • Anchor not lowercase

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

  • broken_links:
    • Anchor not lowercase

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

  • broken_links:
    • Anchor not lowercase
    • No need for the pathname in anchor links if it's the same page

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
Title: Promise
on GitHub
Flaw count: 4

  • broken_links:
    • 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)
    • 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)

External URLs

URL: /en-US/docs/Web/JavaScript/The_performance_hazards_of_prototype_mutation
Title: The performance hazards of [[Prototype]] mutation
on GitHub

No external URLs

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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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

@sideshowbarker sideshowbarker merged commit 7259774 into mdn:main Apr 30, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants