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

JavaScript: clarification for Async. Code recommendation to read article #29124

Open
2 of 3 tasks
hbar1st opened this issue Nov 24, 2024 · 3 comments
Open
2 of 3 tasks

Comments

@hbar1st
Copy link

hbar1st commented Nov 24, 2024

Checks

Describe your suggestion

In the lesson on asynchronous code, the following instruction is given:
Take a moment to skim through this article on callbacks before moving on

I think this should be rephrased to:
Take a moment to skim through this article's explanation of callbacks before moving on

The reason I am suggesting this re-write is because the article is actually a wide-ranging one (it is not only talking about callbacks) and it is not immediately clear when we are sent there that we're supposed to stop reading at the end of the callback section (or so I assume now!) as there's an event section immediately after the callback section which seemed relevant to me for example (as it is presented as an alternative to callbacks), so I kept reading until I finally reached Streams and then I started to suspect I'd read a bit too far at that point).

If I'm correct that the intention is only read the section of the article entitled "Callbacks", then this slight re-wording may make that clearer to the audience.
Thanks for your help.

Path

Node / JS

Lesson Url

https://www.theodinproject.com/lessons/node-path-javascript-asynchronous-code

(Optional) Discord Name

No response

(Optional) Additional Comments

No response

@MaoShizhong
Copy link
Contributor

Amending the link text label to article section on callbacks should be sufficient, since the link is specifically to the callbacks section of the whole thing. So if "article" alone was the source of confusion despite that, "article section" should be clearer while retaining an accessible link text label.

@RonnocNiksab
Copy link

Hey @hbar1st - I noticed you didn't check that you wanted to work on this issue. Are you open to me working on this and submitting the PR? 😊

@MaoShizhong - I hope I'm not overstepping by asking this!

@MaoShizhong
Copy link
Contributor

I'm no longer a maintainer so I'm not the one who can assign people anymore. If the author hasn't requested assignment themselves, then you're welcome to do so, just don't actually open a PR unless you've been assigned by a maintainer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants