Skip to content

Commit

Permalink
Fixed some typos found by a spell checker in the docs (#1141)
Browse files Browse the repository at this point in the history
* Fix some typos found by a spell checker

* Add an empty changeset

---------

Co-authored-by: Yuri Pieters <yuri.pieters@anaplan.com>
  • Loading branch information
MageJohn and Yuri Pieters committed May 6, 2023
1 parent 453aee9 commit 8ede784
Show file tree
Hide file tree
Showing 9 changed files with 11 additions and 9 deletions.
2 changes: 2 additions & 0 deletions .changeset/green-carrots-trade.md
@@ -0,0 +1,2 @@
---
---
2 changes: 1 addition & 1 deletion docs/config-file-options.md
Expand Up @@ -100,7 +100,7 @@ If you want to use this option, you should read the documentation on [linked pac
## `updateInternalDependencies`

This option sets whether, when a package that is being dependend upon changes, whether you should update what version it depends on. To make this more understandable, here is an example:
This option sets whether, when a package that is being depended upon changes, whether you should update what version it depends on. To make this more understandable, here is an example:

Say we have two packages, one depending on the other:

Expand Down
2 changes: 1 addition & 1 deletion docs/fixed-packages.md
Expand Up @@ -32,7 +32,7 @@ I now have another changeset with a minor for `pkg-a` and I do a release, the re

## Using glob expressions

Sometimes you want to fix many or all packages within your project (for example in a monorepository setup), in which case you would need to keep the list of fixed packages up-to-date.
Sometimes you want to fix many or all packages within your project (for example in a monorepo setup), in which case you would need to keep the list of fixed packages up-to-date.

To make it simpler to maintain that list, you can provide glob expressions in the list that would match and resolve to all the packages that you wish to include.

Expand Down
2 changes: 1 addition & 1 deletion docs/intro-to-using-changesets.md
Expand Up @@ -56,7 +56,7 @@ yarn changeset version

This consumes all changesets, and updates to the most appropriate semver version based on those changesets. It also writes changelog entries for each consumed changeset.

We recommend at this step reviewing both the changelog entries and the version changes for packages. Once you are confident that these are correct, and have made any necessary tweeks to changelogs, you can publish your packages:
We recommend at this step reviewing both the changelog entries and the version changes for packages. Once you are confident that these are correct, and have made any necessary tweaks to changelogs, you can publish your packages:

```shell
npx changeset publish
Expand Down
2 changes: 1 addition & 1 deletion docs/linked-packages.md
Expand Up @@ -72,7 +72,7 @@ I now have another changeset with a major for `pkg-a` and I do a release, the re

## Using glob expressions

Sometimes you want to link many or all packages within your project (for example in a monorepository setup), in which case you would need to keep the list of linked packages up-to-date.
Sometimes you want to link many or all packages within your project (for example in a monorepo setup), in which case you would need to keep the list of linked packages up-to-date.

To make it simpler to maintain that list, you can provide glob expressions in the linked list that would match and resolve all the packages you wish to include.

Expand Down
2 changes: 1 addition & 1 deletion packages/apply-release-plan/README.md
Expand Up @@ -22,4 +22,4 @@ await applyReleasePlan(

Note that `apply-release-plan` does not validate the release plan's accuracy.

To generate a releace plan from written changesets use `@changesets/get-release-plan`
To generate a release plan from written changesets use `@changesets/get-release-plan`
2 changes: 1 addition & 1 deletion packages/get-github-info/README.md
Expand Up @@ -35,7 +35,7 @@ const getReleaseLine = async (changeset, type) => {
// getInfo exposes the GH username and PR number if you want them directly
// but it also exposes a set of links for the commit, PR and GH username
let { user, pull, links } = await getInfo({
// replace this will your own repo
// replace this with your own repo
repo: "Noviny/changesets",
commit: changeset.commit,
});
Expand Down
4 changes: 2 additions & 2 deletions packages/get-release-plan/README.md
Expand Up @@ -16,9 +16,9 @@ The directory to run `getReleasePlan` in - most often `process.cwd()`

## since: string

Sets whether to use all changests present, or only those changesets that are new since the branch
Sets whether to use all changesets present, or only those changesets that are new since the branch
diverged from another one.

## passedConfig?: Config

The changeset config options as defined in `@changesets/types`. This is optional, and can be used to overrwrite any written config options.
The changeset config options as defined in `@changesets/types`. This is optional, and can be used to overwrite any written config options.
2 changes: 1 addition & 1 deletion packages/logger/README.md
Expand Up @@ -38,5 +38,5 @@ temporarilySilenceLogs();
log("I am not logged");
// Use console.log to log messages in tests if required
console.log("Yiey, I am logged");
console.log("Yay, I am logged");
```

0 comments on commit 8ede784

Please sign in to comment.