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.

Sign up for GitHub

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

Jump to bottom

Remove HTML tags from code blocks (JS Operator references) #6559

Merged
merged 2 commits into from
Jul 3, 2021
Merged

Remove HTML tags from code blocks (JS Operator references) #6559

merged 2 commits into from
Jul 3, 2021

Conversation

alattalatta
Copy link
Member

@alattalatta alattalatta commented Jul 3, 2021 •
edited

What was wrong/why is this fix needed? (quick summary only)

  1. There was a purpose to html tags such as <strong> and <var|em>s in code blocks. Since Yari strips all inner HTML tags of code blocks, they serve nothing now, and only introduce burdens for update and localization.

  2. Also, as there's no way of explicitly highlighting something in the code blocks, some of writing conventions within JS operator references have become confusing. This PR removes them. (See below for details) It also improves overall consistency of the references.

Issue number (if there is an associated issue)

None.

Anything else that could help us review it

Operator: a + b

// Changed to

a + b
Operator: a += b
Meaning:  a = a + b

// Changed to

a += b // a = a + b

@alattalatta alattalatta requested a review from a team as a code owner July 3, 2021 15:45
@alattalatta alattalatta requested review from sideshowbarker and removed request for a team July 3, 2021 15:45
@alattalatta alattalatta changed the title Remove HTML tags from code blocks Remove HTML tags from code blocks (JS Operator references) Jul 3, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Jul 3, 2021

Preview URLs

Flaws

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

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Unsigned_right_shift_assignment
Title: Unsigned right shift assignment (>>>=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

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

  • broken_links:
    • Can't resolve /en-US/docs/Web/JavaScript/Guide/The_Iterator_protocol

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_AND_assignment
Title: Bitwise AND assignment (&=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Left_shift
Title: Left shift (<<)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_AND
Title: Bitwise AND (&)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Assignment
Title: Assignment (=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Exponentiation_assignment
Title: Exponentiation assignment (**=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Left_shift_assignment
Title: Left shift assignment (<<=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Logical_NOT
Title: Logical NOT (!)
on GitHub
Flaw count: 3

  • broken_links:
    • Anchor not lowercase
    • Can't resolve /en-US/docs/Web/JavaScript/Reference/Operators/Logical_Operators#Logical_NOT
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Equality
Title: Equality (==)
on GitHub
Flaw count: 1

  • broken_links:
    • Is currently http:// but can become https://

URL: /en-US/docs/Web/JavaScript/Reference/Operators/function*
Title: function* expression
on GitHub
Flaw count: 1

  • macros:
    • /en-US/docs/Web/JavaScript/Reference/Functions_and_function_scope redirects to /en-US/docs/Web/JavaScript/Reference/Functions

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_XOR_assignment
Title: Bitwise XOR assignment (^=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

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

  • macros:
    • /en-US/docs/Web/JavaScript/Reference/Arrow_functions redirects to /en-US/docs/Web/JavaScript/Reference/Functions/Arrow_functions
    • /en-US/docs/Web/JavaScript/Reference/Functions_and_function_scope redirects to /en-US/docs/Web/JavaScript/Reference/Functions

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Division_assignment
Title: Division assignment (/=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

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

  • broken_links:
    • Can't resolve /en-US/docs/Glossary/Undefined
    • Is currently http:// but can become https://
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/in
Title: in operator
on GitHub
Flaw count: 1

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

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Remainder_assignment
Title: Remainder assignment (%=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Multiplication_assignment
Title: Multiplication assignment (*=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

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/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/Operators/Logical_AND
Title: Logical AND (&&)
on GitHub
Flaw count: 2

  • broken_links:
    • Anchor not lowercase
    • Can't resolve /en-US/docs/Web/JavaScript/Reference/Operators/Logical_Operators#Logical_NOT

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Right_shift_assignment
Title: Right shift assignment (>>=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Right_shift
Title: Right shift (>>)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_OR_assignment
Title: Bitwise OR assignment (|=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Subtraction_assignment
Title: Subtraction assignment (-=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_OR
Title: Bitwise OR (|)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Addition_assignment
Title: Addition assignment (+=)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Unsigned_right_shift
Title: Unsigned right shift (>>>)
on GitHub
Flaw count: 1

  • broken_links:
    • Anchor not lowercase

External URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Division
Title: Division (/)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Nullish_coalescing_operator
Title: Nullish coalescing operator (??)
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Less_than
Title: Less than (<)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Addition
Title: Addition (+)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Unsigned_right_shift_assignment
Title: Unsigned right shift assignment (>>>=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Exponentiation
Title: Exponentiation (**)
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Property_Accessors
Title: Property accessors
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_AND_assignment
Title: Bitwise AND assignment (&=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Increment
Title: Increment (++)
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Left_shift
Title: Left shift (<<)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_AND
Title: Bitwise AND (&)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Assignment
Title: Assignment (=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Logical_OR
Title: Logical OR (||)
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Exponentiation_assignment
Title: Exponentiation assignment (**=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Left_shift_assignment
Title: Left shift assignment (<<=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Multiplication
Title: Multiplication (*)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Logical_NOT
Title: Logical NOT (!)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Logical_AND_assignment
Title: Logical AND assignment (&&=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Logical_nullish_assignment
Title: Logical nullish assignment (??=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Equality
Title: Equality (==)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/function*
Title: function* expression
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_XOR_assignment
Title: Bitwise XOR assignment (^=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Decrement
Title: Decrement (--)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/function
Title: Function expression
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_XOR
Title: Bitwise XOR (^)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Division_assignment
Title: Division assignment (/=)
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Less_than_or_equal
Title: Less than or equal (<=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Logical_OR_assignment
Title: Logical OR assignment (||=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Remainder_assignment
Title: Remainder assignment (%=)
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Multiplication_assignment
Title: Multiplication assignment (*=)
on GitHub

No new external URLs

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

No new external URLs

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

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Subtraction
Title: Subtraction (-)
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Logical_AND
Title: Logical AND (&&)
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Right_shift_assignment
Title: Right shift assignment (>>=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Right_shift
Title: Right shift (>>)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_NOT
Title: Bitwise NOT (~)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_OR_assignment
Title: Bitwise OR assignment (|=)
on GitHub

No new external URLs

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

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Comma_Operator
Title: Comma operator (,)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Remainder
Title: Remainder (%)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Subtraction_assignment
Title: Subtraction assignment (-=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Unary_negation
Title: Unary negation (-)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Bitwise_OR
Title: Bitwise OR (|)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Addition_assignment
Title: Addition assignment (+=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Greater_than_or_equal
Title: Greater than or equal (>=)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Unary_plus
Title: Unary plus (+)
on GitHub

No new external URLs

URL: /en-US/docs/Web/JavaScript/Reference/Operators/Unsigned_right_shift
Title: Unsigned right shift (>>>)
on GitHub

No new external URLs

@sideshowbarker sideshowbarker merged commit 1b532da into mdn:main Jul 3, 2021
@alattalatta alattalatta mentioned this pull request Jul 11, 2021
Merged
@alattalatta alattalatta deleted the js/operators/no-inner-html branch September 17, 2021 04:52
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 17, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@sideshowbarker sideshowbarker sideshowbarker approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
2 participants
@alattalatta @sideshowbarker