From c4f6a0312a6523c2faf47dd0453d480243e0f186 Mon Sep 17 00:00:00 2001 From: omahs <73983677+omahs@users.noreply.github.com> Date: Mon, 22 Jul 2024 00:24:07 +0200 Subject: [PATCH] docs: fix typos (#9749) docs: fix typos --- MAINTAINERS.md | 2 +- docs/architecture/0001-record-architecture-decisions.md | 2 +- docs/typescript.md | 2 +- packages/swingset-runner/src/main.js | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/MAINTAINERS.md b/MAINTAINERS.md index c6c610454ad..7ef3fcbf856 100644 --- a/MAINTAINERS.md +++ b/MAINTAINERS.md @@ -117,7 +117,7 @@ For each set of changes to include: These are the steps for a Release Manager to create and publish a new release of the Agoric SDK. This combines the process of -GitHub-based release managment and publication together with NPM-based +GitHub-based release management and publication together with NPM-based publication of the SDK and its individual packages. ### Prerequisites diff --git a/docs/architecture/0001-record-architecture-decisions.md b/docs/architecture/0001-record-architecture-decisions.md index cba0f81572c..54b3207ef45 100644 --- a/docs/architecture/0001-record-architecture-decisions.md +++ b/docs/architecture/0001-record-architecture-decisions.md @@ -11,7 +11,7 @@ subject](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-deci Architecture for agile projects has to be described and defined differently. Not all decisions will be made at once, nor will all of them be done when the project begins. -Agile methods are not opposed to documentation, only to valueless documentation. Documents that assist the team itself can have value, but only if they are kept up to date. Large documents are never kept up to date. Small, modular documents have at least a chance at being updated. +Agile methods are not opposed to documentation, only to valueless documentation. Documents that assist the team itself can have value, but only if they are kept up to date. Large documents are never kept up to date. Small, modular documents have at least a chance of being updated. Nobody ever reads large documents, either. Most developers have been on at least one project where the specification document was larger (in bytes) than the total source code size. Those documents are too large to open, read, or update. Bite sized pieces are easier for for all stakeholders to consume. diff --git a/docs/typescript.md b/docs/typescript.md index 39926e740b5..8e612623e15 100644 --- a/docs/typescript.md +++ b/docs/typescript.md @@ -1,6 +1,6 @@ # usage of TypeScript -Our use of TypeScript has to accomodate both .js development in agoric-sdk (which could not import types until TS 5.5) and .ts development of consumers of agoric-sdk packages (which could always import types). For .js development, we have many ambient (global) types so that we don't have to precede each type reference by an import. For .ts development, we want exports from modules so we don't pollute a global namespace. We are slowly transitioning away from ambient types. +Our use of TypeScript has to accommodate both .js development in agoric-sdk (which could not import types until TS 5.5) and .ts development of consumers of agoric-sdk packages (which could always import types). For .js development, we have many ambient (global) types so that we don't have to precede each type reference by an import. For .ts development, we want exports from modules so we don't pollute a global namespace. We are slowly transitioning away from ambient types. ## Best practices diff --git a/packages/swingset-runner/src/main.js b/packages/swingset-runner/src/main.js index e6a20d196a3..6003a30227d 100644 --- a/packages/swingset-runner/src/main.js +++ b/packages/swingset-runner/src/main.js @@ -49,7 +49,7 @@ FLAGS may be: --initonly - initialize the swingset but exit without running it --sqlite - runs using Sqlite3 as the data store (default) --memdb - runs using the non-persistent in-memory data store - --usexs - run vats using the the XS engine + --usexs - run vats using the XS engine --usebundlecache - cache bundles created by swingset loader --dbdir DIR - specify where the data store should go (default BASEDIR) --blockmode - run in block mode (checkpoint every BLOCKSIZE blocks)