Small Grammar and Wording Changes #5
Conversation
| @@ -185,7 +185,7 @@ npm install -g typescript | |||
| > This installs the TypeScript Compiler `tsc` globally. | |||
| > You can use `npx` or similar tools if you'd prefer to run `tsc` from a local `node_modules` package instead. | |||
|
|
|||
| Now let's move to an empty folder and try writing our first TypeScript program: `hello.ts`: | |||
| Now create an empty directory named ts-example and create a new file called: `hello.ts` and input the following code: | |||
There was a problem hiding this comment.
I don't understand how specifying the directory name improves the clarity. Anyway for all code or filenames we've been using fixedwidth formatting
There was a problem hiding this comment.
I was thinking in more of a beginner sense and doing many workshops I've noticed that many people need things specifically spelled out for them. Versus when we write docs we know what we mean.
| @@ -217,7 +217,10 @@ console.log("Hello world!"); | |||
|
|
|||
| In this case, there was very little for TypeScript to transform, so it looks identical to what we wrote. | |||
| The compiler tries to emit clean readable code that looks like something a person would write. | |||
| While that's not always so easy, TypeScript indents consistently, is mindful of when our code spans across different lines of code, and tries to keep comments around. | |||
| While that's not always so easy, TypeScript: | |||
There was a problem hiding this comment.
Is the general idea that all lists of things need to be bullets? I'd like to understand the motivation.
There was a problem hiding this comment.
Yea, so I proposed bullets because it seemed hard to read as one long sentence. It visually helped when I separated them as a bulleted list. Could just be a me thing!
| @@ -321,7 +324,7 @@ That's a feature, and it's best not to add annotations when the type system woul | |||
|
|
|||
| ## Erased Types | |||
|
|
|||
| Let's take a look at what happens when we compile with `tsc`: | |||
| Let's take a look at the differences in the JavaScript code created from `tsc`: | |||
There was a problem hiding this comment.
I like that this calls out that we're looking at the JS code, but "differences" is kind of left hanging in terms of what the other thing we're comparing against is.
There was a problem hiding this comment.
Hmmm I see your point. Maybe "Lets take a look at the JavaScript code created when we compile with tsc"?
| @@ -187,7 +187,7 @@ TypeScript doesn't hurt us here at all, but this is behavior worth noting if you | |||
| TypeScript can often help you catch bugs early on, but if you choose to do *nothing* with a value, there's only so much that it can do without being overly prescriptive. | |||
| If you want, you can make sure you handle situations like these with a linter. | |||
|
|
|||
| One last word on narrowing by truthiness is that Boolean negations with `!` filter out from negated branches. | |||
| One last word on narrowing by truthiness is that Boolean negations with `!`, filter out from negated branches. | |||
There was a problem hiding this comment.
This sentence is a complete disaster (I can barely figure out what it means) and should just be rewritten.
The proposed change doesn't improve it. See "Using A Comma Before A Verb In Relative Clause"
There was a problem hiding this comment.
It's an honor to receive this feedback 😅
There was a problem hiding this comment.
Totally agree the change was not the best as I too had issues figuring out what it meant. I didn't want to change too much but a whole new sentence is preferred.
|
Left some comments and questions; the rest of the changes are 👍👍 |
After reading through the handbook, I made some small changes to some of the wording so that sentences made more sense and grammatically correct.
Let me know if I need to make any other changes!