Remove summary and seoSummary classes from JS docs by wbamberg · Pull Request #4085 · mdn/content

wbamberg · 2021-04-14T00:41:03Z

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.

github-actions · 2021-04-14T02:05:37Z

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

https://en.wikipedia.org/wiki/Double-precision_floating-point_format (1 time)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

https://tc39.es/ecma262/ (3 times)

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

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

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

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

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

Elchi3

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.

Remove summary and seoSummary classes, where they have an effect

bbcc81e

wbamberg requested a review from a team as a code owner April 14, 2021 00:41

wbamberg requested review from Elchi3 and removed request for a team April 14, 2021 00:41

Merge branch 'main' into javascript-remove-summary

6d22cea

Elchi3 approved these changes Apr 14, 2021

View reviewed changes

Elchi3 merged commit 4281bac into mdn:main Apr 14, 2021

hamishwillee mentioned this pull request Apr 16, 2021

[Markdown] Decide what to do about class="summary" and class="seoSummary" #3923

Closed

sideshowbarker mentioned this pull request Jun 6, 2021

Issue with "Math.abs()": … #461

Closed

wbamberg mentioned this pull request Jun 10, 2021

[Markdown] Preparing CSS docs for Markdowning #5865

Closed

13 tasks

sideshowbarker mentioned this pull request Jun 18, 2021

Give additional examples of how to create a MediaStream #6093

Merged

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

wbamberg deleted the javascript-remove-summary branch October 15, 2022 17:24

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Comments

Remove summary and seoSummary classes from JS docs#4085

Remove summary and seoSummary classes from JS docs#4085
Elchi3 merged 2 commits intomdn:mainfrom
wbamberg:javascript-remove-summary

wbamberg commented Apr 14, 2021

Uh oh!

github-actions bot commented Apr 14, 2021

Uh oh!

Elchi3 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Comments

Conversation

wbamberg commented Apr 14, 2021

Uh oh!

github-actions bot commented Apr 14, 2021

Preview URLs

Flaws

External URLs

No external URLs

Uh oh!

Elchi3 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants