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: incorrect line reference in docs #35785

Closed
wants to merge 1 commit into from
Closed

Conversation

RasmusKard
Copy link
Contributor

Description

Changed line number referenced in docs to the correct line.

Motivation

Avoid confusion.

Additional details

HTML file being referenced in docs:

https://github.com/mdn/learning-area/blob/ba2ef1dcbf027cd4778ea258f484045b89905e2b/javascript/introduction-to-js-1/troubleshooting/number-game-errors.html

Related issues and pull requests

@RasmusKard RasmusKard requested a review from a team as a code owner September 7, 2024 05:01
@RasmusKard RasmusKard requested review from chrisdavidmills and removed request for a team September 7, 2024 05:01
@github-actions github-actions bot added Content:Learn:JavaScript Learning area JavaScript docs size/xs [PR only] 0-5 LoC changed labels Sep 7, 2024
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

If you want to do this, you would need to re-upload an error screenshot with the correct line number. Consistency in content is more important than consistency with the external code example, because that one may be constantly updating.

The code example is not properly formatted. Maybe you would want to run Prettier on that HTML so we never have to update the line numbers again, or perhaps we would wait for someone else to do that. Otherwise if we re-format that code one day, we would have to do this all over again.

@Josh-Cena
Copy link
Member

@RasmusKard It looks like we are currently doing a big audit over all external examples, so I'm closing this for now. The content itself makes sense and we will make sure the external example is itself stable before updating content.

@Josh-Cena Josh-Cena closed this Sep 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Learn:JavaScript Learning area JavaScript docs size/xs [PR only] 0-5 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants