aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Matthew Yu <56417255+matthewyu01@users.noreply.github.com> 2023-09-11 08:50:39 -0700
committerGravatar GitHub <noreply@github.com> 2023-09-11 08:50:39 -0700
commit9d6a8ee79df73c4b2160a53d58d8789fff130e95 (patch)
tree7c14a2f03ffb22819a64ee041cc0855ac3d8a7c3
parentb55b511f685d0520ba2110b1182980ac80a7b3b7 (diff)
downloadbun-9d6a8ee79df73c4b2160a53d58d8789fff130e95.tar.gz
bun-9d6a8ee79df73c4b2160a53d58d8789fff130e95.tar.zst
bun-9d6a8ee79df73c4b2160a53d58d8789fff130e95.zip
Fix punctuation (#4870)
-rw-r--r--docs/api/binary-data.md2
-rw-r--r--docs/guides/ecosystem/mongoose.md2
-rw-r--r--docs/guides/ecosystem/solidstart.md2
-rw-r--r--docs/guides/install/workspaces.md2
-rw-r--r--docs/project/development.md2
-rw-r--r--docs/runtime/index.md4
-rw-r--r--src/js/README.md4
7 files changed, 9 insertions, 9 deletions
diff --git a/docs/api/binary-data.md b/docs/api/binary-data.md
index 2ce7c320f..a75d08309 100644
--- a/docs/api/binary-data.md
+++ b/docs/api/binary-data.md
@@ -74,7 +74,7 @@ dv.getUint8(0); // => 3
// [0x11, 0x0, 0x0, 0x0]
```
-Now lets write a `Uint16` at byte offset `1`. This requires two bytes. We're using the value `513`, which is `2 * 256 + 1`; in bytes, that's `00000010 00000001`.
+Now let's write a `Uint16` at byte offset `1`. This requires two bytes. We're using the value `513`, which is `2 * 256 + 1`; in bytes, that's `00000010 00000001`.
```ts
dv.setUint16(1, 513);
diff --git a/docs/guides/ecosystem/mongoose.md b/docs/guides/ecosystem/mongoose.md
index 043ec4f22..c06821dde 100644
--- a/docs/guides/ecosystem/mongoose.md
+++ b/docs/guides/ecosystem/mongoose.md
@@ -75,7 +75,7 @@ await mongoose.disconnect();
---
-Lets run this with `bun run`.
+Let's run this with `bun run`.
```bash
$ bun run index.ts
diff --git a/docs/guides/ecosystem/solidstart.md b/docs/guides/ecosystem/solidstart.md
index b6062c903..ca2ef471e 100644
--- a/docs/guides/ecosystem/solidstart.md
+++ b/docs/guides/ecosystem/solidstart.md
@@ -30,7 +30,7 @@ cloned solidjs/solid-start#main to /path/to/my-app/.solid-start
---
-As instructed by the `create-solid` CLI, lets install our dependencies.
+As instructed by the `create-solid` CLI, let's install our dependencies.
```sh
$ cd my-app
diff --git a/docs/guides/install/workspaces.md b/docs/guides/install/workspaces.md
index 7c359b285..f87c1e337 100644
--- a/docs/guides/install/workspaces.md
+++ b/docs/guides/install/workspaces.md
@@ -35,7 +35,7 @@ It's common to place all packages in a `packages` directory. The `"workspaces"`
---
-To add one workspace as a dependency of another, modify its `package.json`. Here were adding `stuff-a` as a dependency of `stuff-b`.
+To add one workspace as a dependency of another, modify its `package.json`. Here we're adding `stuff-a` as a dependency of `stuff-b`.
```json#packages/stuff-b/package.json
{
diff --git a/docs/project/development.md b/docs/project/development.md
index 987448237..c5345772c 100644
--- a/docs/project/development.md
+++ b/docs/project/development.md
@@ -127,7 +127,7 @@ After cloning the repository, run the following command to run the first build.
$ make setup
```
-The binary will be located at `packages/debug-bun-{platform}-{arch}/bun-debug`. It is recommended to add this to your `$PATH`. To verify the build worked, lets print the version number on the development build of Bun.
+The binary will be located at `packages/debug-bun-{platform}-{arch}/bun-debug`. It is recommended to add this to your `$PATH`. To verify the build worked, let's print the version number on the development build of Bun.
```bash
$ packages/debug-bun-*/bun-debug --version
diff --git a/docs/runtime/index.md b/docs/runtime/index.md
index 04f0e7ffd..4c557cab4 100644
--- a/docs/runtime/index.md
+++ b/docs/runtime/index.md
@@ -2,7 +2,7 @@ Bun is a new JavaScript & TypeScript runtime designed to be a faster, leaner, an
## Speed
-Bun is designed to start fast and run fast. It's transpiler and runtime are written in Zig, a modern, high-performance language. On Linux, this translates into startup times [4x faster](https://twitter.com/jarredsumner/status/1499225725492076544) than Node.js.
+Bun is designed to start fast and run fast. Its transpiler and runtime are written in Zig, a modern, high-performance language. On Linux, this translates into startup times [4x faster](https://twitter.com/jarredsumner/status/1499225725492076544) than Node.js.
{% image src="/images/bun-run-speed.jpeg" caption="Bun vs Node.js vs Deno running Hello World" /%}
@@ -27,7 +27,7 @@ Some aspects of Bun's runtime behavior are affected by the contents of your `tsc
<!--
-every file before execution. It's transpiler can directly run TypeScript and JSX `{.js|.jsx|.ts|.tsx}` files directly. During execution, Bun internally transpiles all files (including `.js` files) to vanilla JavaScript with it's fast native transpiler. -->
+every file before execution. Its transpiler can directly run TypeScript and JSX `{.js|.jsx|.ts|.tsx}` files directly. During execution, Bun internally transpiles all files (including `.js` files) to vanilla JavaScript with its fast native transpiler. -->
<!-- A loader determines how to map imports &amp; file extensions to transforms and output. -->
diff --git a/src/js/README.md b/src/js/README.md
index 82acf7c51..f1eb3c6ca 100644
--- a/src/js/README.md
+++ b/src/js/README.md
@@ -36,7 +36,7 @@ V8 has a [similar feature](https://v8.dev/blog/embedded-builtins) to this syntax
On top of this, we have some special functions that are handled by the builtin preprocessor:
-- `require` works, but it must be passed a **string literal** that resolves to a module within `src/js`. This call gets replaced with `$getInternalField($internalModuleRegistery, <number>)`, which directly loads the module by it's generated numerical ID, skipping the resolver for inter-internal modules.
+- `require` works, but it must be passed a **string literal** that resolves to a module within `src/js`. This call gets replaced with `$getInternalField($internalModuleRegistery, <number>)`, which directly loads the module by its generated numerical ID, skipping the resolver for inter-internal modules.
- `$debug` is exactly like console.log, but is stripped in release builds. It is disabled by default, requiring you to pass one of: `BUN_DEBUG_MODULE_NAME=1`, `BUN_DEBUG_JS=1`, or `BUN_DEBUG_ALL=1`. You can also do `if($debug) {}` to check if debug env var is set.
@@ -57,7 +57,7 @@ export default {
};
```
-Keep in mind that **these are not ES modules**. `export default` is only syntax sugar to assign to the variable `$exports`, which is actually how the module exports it's contents. `export var` and `export function` are banned syntax, and so is `import` (use `require` instead)
+Keep in mind that **these are not ES modules**. `export default` is only syntax sugar to assign to the variable `$exports`, which is actually how the module exports its contents. `export var` and `export function` are banned syntax, and so is `import` (use `require` instead)
To actually wire up one of these modules to the resolver, that is done separately in `module_resolver.zig`. Maybe in the future we can do codegen for it.