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

ES6 Modules: Clarify examples won't work without next section #28662

Merged

Conversation

MaoShizhong
Copy link
Contributor

Because

People often like to code along to lessons. The ES6 modules lesson first shows import/export syntax, then teaches how to link the entry point as a module script. Since it doesn't make it clear both things are needed, some people may get confused when the import/export code errors. A quick clarification is all that's needed here.

This PR

  • Clarify some code examples won't work straight away
  • Suggest going back to rewrite IIFE examples to use ESM if people wish to "code along".

Issue

N/A

Pull Request Requirements

  • I have thoroughly read and understand The Odin Project curriculum contributing guide
  • The title of this PR follows the location of change: brief description of change format, e.g. Intro to HTML and CSS lesson: Fix link text
  • The Because section summarizes the reason for this PR
  • The This PR section has a bullet point list describing the changes in this PR
  • If this PR addresses an open issue, it is linked in the Issue section
  • If any lesson files are included in this PR, they have been previewed with the Markdown preview tool to ensure it is formatted correctly
  • If any lesson files are included in this PR, they follow the Layout Style Guide

@github-actions github-actions bot added the Content: JavaScript Involves the JavaScript course label Aug 19, 2024
Copy link
Contributor

@JoshDevHub JoshDevHub left a comment

Choose a reason for hiding this comment

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

🚀

@MaoShizhong MaoShizhong merged commit 7c59f78 into TheOdinProject:main Aug 19, 2024
2 checks passed
@MaoShizhong MaoShizhong deleted the es6-modules-clarification branch August 19, 2024 15:28
@Salomanuel
Copy link

Just as feedback, even after this PR got merged I STILL had lots of issues understanding that the examples would never work as they were presented (what's the point of examples if they don't work? As a student you even lose trust in the process if the teacher "is wrong").

I had to look into GitHub to see if something was going on (and indeed there was! (this PR)).

I'd just state more clearly at the beginning of the lesson, something like "BEWARE FELLOW STUDENT, NONE OF THESE EXAMPLES WILL WORK AS OF NOW, so don't even bother coding along while reading" or just rewrite the whole thing so it starts making sense. :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content: JavaScript Involves the JavaScript course
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants