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 all line number references to inline code examples #34459

Merged
merged 1 commit into from
Jun 28, 2024
Merged

Remove all line number references to inline code examples #34459

merged 1 commit into from
Jun 28, 2024

Conversation

Josh-Cena
Copy link
Member

@Josh-Cena Josh-Cena commented Jun 27, 2024 •
edited
Loading

Fix #33122.

Since Yari doesn't render line numbers in code examples, these line number references are actually useless and it's better to explain the code conceptually step-by-step rather than line-by-line, so it's also resilient to formatting.

@Josh-Cena Josh-Cena requested review from a team as code owners June 27, 2024 15:38
@Josh-Cena Josh-Cena requested review from sideshowbarker, teoli2003 and estelle and removed request for a team June 27, 2024 15:38
@github-actions github-actions bot added Content:CSS Cascading Style Sheets docs Content:WebAPI Web API docs Content:JS JavaScript docs Content:HTTP HTTP docs Content:Accessibility Accessibility docs Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees Content:Learn:JavaScript Learning area JavaScript docs size/m [PR only] 51-500 LoC changed labels Jun 27, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jun 27, 2024 •
edited
Loading

Preview URLs (28 pages)
Flaws (5)

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

URL: /en-US/docs/Web/HTTP/CORS
Title: Cross-Origin Resource Sharing (CORS)
Flaw count: 3

  • images:
    • External image URL
    • External image URL
    • External image URL

URL: /en-US/docs/Web/CSS/Cascade
Title: Introducing the CSS Cascade
Flaw count: 1

  • macros:
    • /en-US/docs/Web/CSS/align does not exist

URL: /en-US/docs/Web/API/RTCDataChannel/message_event
Title: RTCDataChannel: message event
Flaw count: 1

  • macros:
    • Wrong xref macro used (consider changing which macro you use). Error processing path /en-US/docs/Web/API/RTCRtpCodecParameters
External URLs (1)

URL: /en-US/docs/Web/API/SourceBuffer/abort
Title: SourceBuffer: abort() method

(comment last updated: 2024-06-27 15:46:58)

@github-actions github-actions bot added the Content:Learn Learning area docs label Jun 27, 2024
bsmth
bsmth approved these changes Jun 27, 2024
View reviewed changes
Copy link
Member

@bsmth bsmth left a comment

Choose a reason for hiding this comment

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

There's a few flaws reported, but I had a look through the diffs and everything looks good to me, so leaving my +1

@Josh-Cena
Copy link
Member Author

Yeah they don't seem related to this PR.

@sideshowbarker sideshowbarker merged commit 23e1a97 into mdn:main Jun 28, 2024
8 checks passed
@Josh-Cena Josh-Cena deleted the rm-line-num branch June 28, 2024 03:24
wbamberg added a commit to wbamberg/content that referenced this pull request Jun 29, 2024
@wbamberg
Merge remote-tracking branch 'upstream/main' into requestinit
460ca9a 
* upstream/main: (58 commits)
  Update arrow function documentation to clarify naming and assignment (mdn#34501)
  update fetch guide (mdn#34278)
  Replace alert in Learn/JavaScript/First_steps/Variables (mdn#34487)
  Replace alert in MDN/Writing_guidelines/Page_structures/Live_samples (mdn#34479)
  Fix typo (mdn#34486)
  Remove SVG color-profile attribute (mdn#34482)
  Remove SVG enable-background attribute (mdn#34483)
  Remove SVG kerning attribute (mdn#34475)
  Updated the description of `targetOrigin`  to specify the intended re… (mdn#34114)
  Mention CSWH in WebSocket server guide (mdn#34411)
  Add note to CSP sandbox saying allow-top-navigation is redundant (mdn#34415)
  Mention navigator.languages may be truncated and Accept-Language may have fallback (mdn#34418)
  Remove IDB output "example", preferring live example (mdn#34464)
  Mention that pinch-zoom are also wheel events (mdn#34468)
  Mention that flex-basis is floored at min-content (mdn#34469)
  More content to Global object glossary (mdn#34471)
  Fix IDB cursor prev direction description (mdn#34463)
  Remove all line number references to inline code examples (mdn#34459)
  Remove link to notification example (mdn#34412)
  Replaces HTML entity glossary links/mentions with char reference (mdn#34391)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bsmth bsmth bsmth approved these changes

@sideshowbarker sideshowbarker sideshowbarker approved these changes

@teoli2003 teoli2003 Awaiting requested review from teoli2003 teoli2003 is a code owner automatically assigned from mdn/yari-content-http

@estelle estelle Awaiting requested review from estelle estelle is a code owner automatically assigned from mdn/yari-content-css

Assignees
No one assigned
Labels
Content:Accessibility Accessibility docs Content:CSS Cascading Style Sheets docs Content:HTTP HTTP docs Content:JS JavaScript docs Content:Learn:Client-side Content under “Client-side JavaScript frameworks” (Svelte, React, Angular, Vue) and related subtrees Content:Learn:JavaScript Learning area JavaScript docs Content:Learn Learning area docs Content:WebAPI Web API docs size/m [PR only] 51-500 LoC changed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Synchronous and asynchronous requests: explanation doesn't make sense without line numbers
3 participants
@Josh-Cena @sideshowbarker @bsmth