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

Modernize the JavaScript syntax in our tutorials #2544

Closed
joeyparrish opened this issue May 1, 2020 · 0 comments · Fixed by #2693
Closed

Modernize the JavaScript syntax in our tutorials #2544

joeyparrish opened this issue May 1, 2020 · 0 comments · Fixed by #2693
Labels
status: archived Archived and locked; will not be updated type: docs Improvements or fixes to documentation
Milestone
v3.1

Comments

@joeyparrish
Copy link
Member

In many older tutorials, we use things like var and .then() that we forbid in our actual codebase. It would be more readable if the docs used a more modern syntax, especially around Promises. Not only is await easier to read, but our use of .then() in docs may mislead a reader into thinking that they must do the same.
@joeyparrish joeyparrish added the type: docs Improvements or fixes to documentation label May 1, 2020
@joeyparrish joeyparrish added this to the Backlog milestone May 1, 2020
This was referenced Jun 29, 2020
Merged
Merged
joeyparrish pushed a commit that referenced this issue Jun 29, 2020
docs: change variable declaration to modern syntax (#2692)
dd48cef 
Issue #2544
joeyparrish pushed a commit that referenced this issue Jun 29, 2020
docs: change promise then to await (#2693)
7ab9031 
Closes #2544
@joeyparrish joeyparrish modified the milestones: Backlog, v3.1 Jul 17, 2020
joeyparrish pushed a commit that referenced this issue Jul 27, 2020
@joeyparrish
docs: change variable declaration to modern syntax (#2692)
d0acf37 
Issue #2544
joeyparrish pushed a commit that referenced this issue Jul 27, 2020
@joeyparrish
docs: change promise then to await (#2693)
4d73741 
Closes #2544
joeyparrish pushed a commit that referenced this issue Jul 27, 2020
@joeyparrish
docs: change variable declaration to modern syntax (#2692)
7087585 
Issue #2544

Backported to v2.5.x

Change-Id: I4b6644204403ed0c29c7a299c5fa813c722bd7f5
joeyparrish pushed a commit that referenced this issue Jul 27, 2020
@joeyparrish
docs: change promise then to await (#2693)
6fbeb69 
Closes #2544
@shaka-project shaka-project locked and limited conversation to collaborators Aug 28, 2020
@shaka-bot shaka-bot added the status: archived Archived and locked; will not be updated label Apr 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
status: archived Archived and locked; will not be updated type: docs Improvements or fixes to documentation
Projects
None yet
Milestone
v3.1
Development

Successfully merging a pull request may close this issue.

docs: change promise then to await
2 participants
@joeyparrish @shaka-bot