Skip to content

Remove summary and seoSummary classes from JS docs #4085

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

Merged
merged 2 commits into from
Apr 14, 2021

Conversation

wbamberg
Copy link
Collaborator

Fixes #4083.

This removes all uses of summary or seoSummary in cases where those classes actually do something. In most cases the classes are selecting the first portion of the first paragraph, and in most of those cases I've just removed them so we will use the whole first paragraph. I think this is OK, none of them are very long, and in the other 800-odd pages where we are not using these classes there are many similarly long paragraphs: https://gist.github.com/wbamberg/3e6f1d6d995189596647a7342c3f0d9e.

In a few places I've made more extensive changes, for wording, or to try to make the summary more coherent.

@wbamberg wbamberg requested a review from a team as a code owner April 14, 2021 00:41
@wbamberg wbamberg requested review from Elchi3 and removed request for a team April 14, 2021 00:41
@github-actions
Copy link
Contributor

Preview URLs

Flaws

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

No flaws! 🎉


URL: /en-US/docs/Web/JavaScript/EventLoop
Title: Concurrency model and the event loop
on GitHub

No flaws! 🎉


URL: /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
Title: Numbers and dates
on GitHub

No flaws! 🎉


URL: /en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators
Title: Iterators and generators
on GitHub

No flaws! 🎉


URL: /en-US/docs/Web/JavaScript/Typed_arrays
Title: JavaScript typed arrays
on GitHub
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Code_snippets/StringView

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

No flaws! 🎉


URL: /en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining
Title: Optional chaining (?.)
on GitHub
Flaw count: 2

  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Conditional_Operator
Title: Conditional (ternary) operator
on GitHub

No flaws! 🎉


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

No flaws! 🎉


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

  • bad_pre_tags:
    • <pre><code>CODE can be just <pre>CODE

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

No flaws! 🎉


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

  • broken_links:
    • Anchor not lowercase

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

No flaws! 🎉


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

No flaws! 🎉


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

  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase
    • Anchor not lowercase

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

No flaws! 🎉


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

  • broken_links:
    • Can't resolve /en-US/docs/Web/JavaScript/Reference/template_strings
    • Can't resolve /en-US/docs/Web/JavaScript/Reference/template_strings#Tagged_template_literals
    • Can't resolve /en-US/docs/Web/JavaScript/Reference/template_strings
  • bad_pre_tags:
    • <pre><code>CODE can be just <pre>CODE

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

  • broken_links:
    • Anchor not lowercase
    • Anchor not lowercase

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

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

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

  • macros:
    • /en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleFormat does not exist

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

  • macros:
    • /en-US/docs/Web/JavaScript/Reference/Global_Objects/DateTimeFormat redirects to /en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat

URL: /en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/Date
Title: Date() constructor
on GitHub
Flaw count: 2

  • macros:
    • /en-US/docs/Web/JavaScript/Reference/new does not exist
  • broken_links:
    • Anchor not lowercase

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

No flaws! 🎉


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

No flaws! 🎉


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

No flaws! 🎉

External URLs

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


URL: /en-US/docs/Web/JavaScript/EventLoop
Title: Concurrency model and the event loop
on GitHub


URL: /en-US/docs/Web/JavaScript/Guide/Numbers_and_dates
Title: Numbers and dates
on GitHub


URL: /en-US/docs/Web/JavaScript/Guide/Iterators_and_Generators
Title: Iterators and generators
on GitHub

No external URLs

URL: /en-US/docs/Web/JavaScript/Typed_arrays
Title: JavaScript typed arrays
on GitHub


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


URL: /en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining
Title: Optional chaining (?.)
on GitHub


URL: /en-US/docs/Web/JavaScript/Reference/Operators/Conditional_Operator
Title: Conditional (ternary) operator
on GitHub


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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


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

Copy link
Member

@Elchi3 Elchi3 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me!
I think it is okay to remove the MathML as well. It is probably enough to explain the things in English and it avoids the compat problems with displaying MathML well enough across browsers.

@Elchi3 Elchi3 merged commit 4281bac into mdn:main Apr 14, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Aug 17, 2022
@wbamberg wbamberg deleted the javascript-remove-summary branch October 15, 2022 17:24
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.

[Markdown] Remove summary and seoSummary from the JS docs
2 participants