Skip to content

Commit 9262f99

Browse files
authored
docs: fix typos in developer docs (#27716)
I found some typos in `CONTRIBUTING.md` and `INTEGRATION_TESTS.md`. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
1 parent d57504e commit 9262f99

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -164,7 +164,7 @@ The `dist/` folder within each module contains the packaged up language artifact
164164
The AWS CDK provides a VS Code Dev Container with all dependencies pre-installed.
165165
Please follow the [setup instructions](https://code.visualstudio.com/docs/remote/containers-tutorial) to configure VS Code.
166166

167-
With VS Code setup, you will be prompted to open the `aws-cdk` repo in a Dev Container, or you can choos "Dev Containers: Reopen in Container" from the VS Code command palette.
167+
With VS Code setup, you will be prompted to open the `aws-cdk` repo in a Dev Container, or you can choose "Dev Containers: Reopen in Container" from the VS Code command palette.
168168

169169
### Gitpod
170170

@@ -1185,7 +1185,7 @@ restart the TypeScript compiler.
11851185

11861186
Hit F1, type `> TypeScript: Restart TS Server`.
11871187

1188-
#### I'm doing refactorings between packages and compile times are killing me/I need to switch between differently-verionsed branches a lot and rebuilds because of version errors are taking too long.
1188+
#### I'm doing refactorings between packages and compile times are killing me/I need to switch between differently-versioned branches a lot and rebuilds because of version errors are taking too long.
11891189

11901190
Our build steps for each package do a couple of things, such as generating code and generating JSII assemblies. If
11911191
you've done a full build at least once to generate all source files, you can do a quicker TypeScript-only rebuild of the

INTEGRATION_TESTS.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -285,12 +285,12 @@ const source = testCase.assertions.awsApiCall('CodePipeline', 'GetPipeline', {
285285
});
286286

287287
// assert the value at the given path matches the expected string
288-
// the numbers index arryas in the json response object
288+
// the numbers index arrays in the json response object
289289
source.assertAtPath('pipeline.stages.0.actions.0.name', integ.ExpectedResult.stringLikeRegexp(expectedString));
290290
```
291291
A helpful trick is to deploy the integ test with `--no-clean` and then make the api call locally. We can then trace the path to specific values easily. For example, `> aws codepipeline get-pipeline --name MyFirstPipeline`.
292292

293-
Adding assertions is prefered on all new integ tests; however, it is not strictly required. We typically do not need to assert CloudFormation behavior. For example, if we create an S3 Bucket
293+
Adding assertions is preferred on all new integ tests; however, it is not strictly required. We typically do not need to assert CloudFormation behavior. For example, if we create an S3 Bucket
294294
with Encryption, we do not need to assert that Encryption is set on the bucket. We can trust that the CloudFormation behavior works.
295295
Some things you should look for in deciding if the test needs an assertion:
296296

0 commit comments

Comments
 (0)