curriculum icon indicating copy to clipboard operation
curriculum copied to clipboard

JavaScript: clarification for Async. Code recommendation to read article

Open hbar1st opened this issue 1 year ago • 7 comments

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

hbar1st avatar Nov 24 '24 23:11 hbar1st

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.

mao-sz avatar Nov 25 '24 01:11 mao-sz

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!

RonnocNiksab avatar Nov 26 '24 00:11 RonnocNiksab

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.

mao-sz avatar Nov 26 '24 00:11 mao-sz

@RonnocNiksab have at it, thanks for volunteering and thank you @hbar1st for raising the issue!

wise-king-sullyman avatar Dec 10 '24 02:12 wise-king-sullyman

This issue is stale because it has had no activity for the last 30 days.

github-actions[bot] avatar Jan 10 '25 02:01 github-actions[bot]

Hey @RonnocNiksab, just checking in - are you still working on this, or would you like us to give someone else a shot at it?

KevinMulhern avatar May 26 '25 13:05 KevinMulhern

Hi @KevinMulhern - someone else can take a shot. I apologize for the delay in reply, my notifications settings were not what I expected.

RonnocNiksab avatar Jun 06 '25 19:06 RonnocNiksab

Hi @KevinMulhern! I’d be happy to work on this issue — I think it would be a great first PR for me to contribute. Please let me know if I can go ahead and take it. Thanks!

thedenisovan avatar Jul 19 '25 12:07 thedenisovan

Sure thing @mozartdd, I've assigned it to you!

KevinMulhern avatar Jul 19 '25 12:07 KevinMulhern