Skip to content

Commit

Permalink
docs(language): removes "simply" to be more inclusive (#342)
Browse files Browse the repository at this point in the history
Co-authored-by: Jared Palmer <jared@jaredpalmer.com>
  • Loading branch information
bmuenzenmeyer and jaredpalmer committed Dec 17, 2021
1 parent 799f3c8 commit ac2793a
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion cli/internal/run/run.go
Original file line number Diff line number Diff line change
Expand Up @@ -321,7 +321,7 @@ func (c *RunCommand) Run(args []string) int {
}
}

// If we are running in parallel, then we simply remove all the edges in the graph
// If we are running in parallel, then we remove all the edges in the graph
// except for the root
if runOptions.parallel {
for _, edge := range ctx.TopologicalGraph.Edges() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ As it turns out, you might not even need references or even an interim TypeScrip
}
```

As it turns out, the TypeScript Language Server (in VSCode) and Type Checker can treat both a raw `.ts` or `.tsx` file as its own valid type declaration. This last sentence is obvious once you read it twice. What isn't so obvious, though, is that you can just point the `types` field directly to raw source code.
As it turns out, the TypeScript Language Server (in VSCode) and Type Checker can treat both a raw `.ts` or `.tsx` file as its own valid type declaration. This last sentence is obvious once you read it twice. What isn't so obvious, though, is that you can point the `types` field directly to raw source code.

Once you do this, this package can then be used _without_ project references or a TypeScript build step (either via `tsc` or `esbuild` etc) as long as you adhere to 2 rules:

Expand All @@ -60,7 +60,7 @@ Internal packages just work. No extra config is needed.

### React Native

If you use [Expo](https://expo.io) and use the [`expo-yarn-workspaces`](https://github.com/expo/expo/tree/master/packages/expo-yarn-workspaces) or [`@turborepo/adapter-expo`](https://www.npmjs.com/package/@turborepo/adapter-expo) package, you can just use internal packages as long as you are targeting iOS or Android. When you run Expo for these platforms, all of `node_modules` are automatically transpiled with [Metro](https://facebook.github.io/metro/). However, if you are targeting Expo for web, internal packages will not work because `node_modules` are oddly not transpiled for web.
If you use [Expo](https://expo.io) and use the [`expo-yarn-workspaces`](https://github.com/expo/expo/tree/master/packages/expo-yarn-workspaces) or [`@turborepo/adapter-expo`](https://www.npmjs.com/package/@turborepo/adapter-expo) package, you can use internal packages as long as you are targeting iOS or Android. When you run Expo for these platforms, all of `node_modules` are automatically transpiled with [Metro](https://facebook.github.io/metro/). However, if you are targeting Expo for web, internal packages will not work because `node_modules` are oddly not transpiled for web.

_I reached out to the Expo team about this inconsistency. They are aware of it. It's a legacy wart I'm told._

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/docs/features/caching.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ To override the default cache folder behavior, pass an array of globs to a [`pip
}
```

If your task does not emit any files (e.g. unit tests with Jest), just set `outputs` to an empty array (i.e. `[]`). Turborepo will automagically cache the logs for you.
If your task does not emit any files (e.g. unit tests with Jest), set `outputs` to an empty array (i.e. `[]`). Turborepo will automagically cache the logs for you.

<Callout emoji="ℹ️">
Pro Tip for caching ESLint: You can get a cacheable pretty terminal output
Expand All @@ -53,7 +53,7 @@ And open up your `node_modules/.cache/turbo`, you should see the cached artifact

## Turn off caching

Sometimes you really don't need or want this cache behavior (such as when you're doing something with live reloading such as `next dev` or `react-scripts start`). To entirely disable caching, simply append `--no-cache` to any command:
Sometimes you really don't need or want this cache behavior (such as when you're doing something with live reloading such as `next dev` or `react-scripts start`). To entirely disable caching, append `--no-cache` to any command:

```shell
# Run `dev` npm script in all packages and apps in parallel,
Expand Down Expand Up @@ -112,7 +112,7 @@ The hash of a given task is injected at execution time as an environment variabl
<Callout>
As of `turbo` v0.6.10, `turbo`'s hashing algorithm when using `npm` or `pnpm`
differs slightly from the above. When using either of these package managers,
`turbo` will simply include the hashed contents of the lockfile in its hash
`turbo` will include the hashed contents of the lockfile in its hash
algorithm for each package's task. It will _not_ parse/figure out the resolved
set of all dependencies like the current `yarn` implementation.
</Callout>
2 changes: 1 addition & 1 deletion docs/pages/docs/features/remote-caching.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ Then run the same build again. If things are working properly, `turbo` should no

### Remote Caching on Vercel Builds

If you are building and hosting your apps on Vercel, then Remote Caching will be automatically set up for you on your behalf once you use `turbo`. You just need to update your build settings to build with `turbo`.
If you are building and hosting your apps on Vercel, then Remote Caching will be automatically set up for you on your behalf once you use `turbo`. You need to update your build settings to build with `turbo`.

Please refer to the [Vercel documentation](https://vercel.com/docs/concepts/git/monorepos#turborepo?utm_source=turborepo.org&utm_medium=referral&utm_campaign=docs-link) for instructions.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/features/scopes.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ turbo run build --scope=*build-tools*

## Scoped tasks with no dependents & their dependencies

Sometimes we want to run the tasks needed to satisfy the `build` script of all the packages that has the `build-tools` string in their names. Think of this as running tasks up and including the package matched in the scope. Simply add a `--no-deps` flag to run up to a package task.
Sometimes we want to run the tasks needed to satisfy the `build` script of all the packages that has the `build-tools` string in their names. Think of this as running tasks up and including the package matched in the scope. Add a `--no-deps` flag to run up to a package task.

```sh
turbo run build --scope=*build-tools* --no-deps --includeDependencies
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ To see more examples and starters, have a look at the [examples directory on Git

## Add Turborepo to your existing monorepo

Turborepo was designed to be incrementally adopted. Adding it to an existing monorepo takes just a few minutes.
Turborepo was designed to be incrementally adopted. Adding it to an existing monorepo takes only a few minutes.

Turborepo works with [Yarn v1](https://classic.yarnpkg.com/lang/en/), [NPM](https://npmjs.com), and [PNPM](https://pnpm.io/) workspaces. The `turbo` CLI works on the following operating systems.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/glossary.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ In mathematics, particularly graph theory, and computer science, a directed acyc

## Hash function

A hash function is any function that can be used to map data of arbitrary size to fixed-size values. The values returned by a hash function are called hash values, hash codes, digests, or simply hashes.
A hash function is any function that can be used to map data of arbitrary size to fixed-size values. The values returned by a hash function are called hash values, hash codes, digests, or hashes.

[Learn more](https://en.wikipedia.org/wiki/Hash_function)

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/reference/command-line-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ turbo run build test lint --graph=my-graph.html
<Callout>
**Known Bug**: All possible pipeline task nodes will be added to the
graph at the moment, even if that pipeline task does not actually exist in a
given package. This has no impact on execution, it just means that:
given package. This has no impact on execution, it means that:

- the terminal output may overstate the number of packages in which a task is running.
- your dot viz graph may contain additional nodes that represents tasks that do not exist.
Expand Down

1 comment on commit ac2793a

@vercel
Copy link

@vercel vercel bot commented on ac2793a Dec 17, 2021

Choose a reason for hiding this comment

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

Please sign in to comment.