Skip to content

Fix incorrect imports of express + fix typos/missing words #145

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

Merged
merged 2 commits into from
Jun 17, 2025

Conversation

DavidIsrawi
Copy link
Member

Purpose

  • Going through the tutorial, I noticed a few typos worth pushing a PR to address
  • For the Typescript code snippets, the import of express is wrong - it should be an import of the express module, not all as express

Does this introduce a breaking change?

When developers merge from main and run the server, azd up, or azd deploy, will this produce an error?
If you're not sure, try it out on an old environment.

[ ] Yes
[X] No

Does this require changes to learn.microsoft.com docs or modules?

which includes deployment, settings and usage instructions.

[ ] Yes
[X] No

Type of change

[ ] Bugfix
[ ] Feature
[ ] Code style update (formatting, local variables)
[X] Refactoring (no functional changes, no api changes)
[X] Documentation content changes
[ ] Other... Please describe:

@Copilot Copilot AI review requested due to automatic review settings June 17, 2025 21:30
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR fixes typos in the documentation and corrects the import syntax for express in the TypeScript code examples, ensuring clarity and consistency throughout the tutorial.

  • Fixed multiple typos and grammatical issues in the README.
  • Updated the express import to the proper ES6 default import.
Comments suppressed due to low confidence (4)

03-GettingStarted/05-sse-server/README.md:22

  • The insertion of a semicolon improves clarity in listing the required responsibilities.
- SSE needs you to handle two things; connection and messages.

03-GettingStarted/05-sse-server/README.md:23

  • Changing 'Visual Studio' to 'Visual Studio Code' ensures the tool reference is up-to-date and clear.
- As this is a server that can live anywhere, you need that to reflect in how you work with tools like the Inspector and Visual Studio Code. What that means is that instead of pointing out how to start the server, you instead point to the endpoint where it can establish a connection. See below example code:

03-GettingStarted/05-sse-server/README.md:145

  • Updating the phrase from 'Defined an using' to 'Defined an app using' significantly improves clarity.
- Defined an app using the web framework express.

03-GettingStarted/05-sse-server/README.md:528

  • Changing the sentence to reflect proper subject-verb agreement improves clarity.
The key takeaways from this chapter are the following:

@@ -4,7 +4,7 @@ SSE (Server Sent Events) is a standard for server-to-client streaming, allowing

## Overview

This lesson covers ow to build and consume SSE Servers.
This lesson covers how to build and consume SSE Servers.
Copy link
Preview

Copilot AI Jun 17, 2025

Choose a reason for hiding this comment

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

Corrected typo from 'ow' to 'how' to improve readability.

Copilot uses AI. Check for mistakes.

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@leestott leestott merged commit 27fb750 into microsoft:main Jun 17, 2025
1 check passed
@DavidIsrawi DavidIsrawi deleted the fixTyposPlusBadImports branch June 17, 2025 21:49
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

Successfully merging this pull request may close these issues.

2 participants