Skip to content

Commit

Permalink
docs: fix typos (#9749)
Browse files Browse the repository at this point in the history
docs: fix typos
  • Loading branch information
omahs committed Jul 21, 2024
1 parent c87930e commit c4f6a03
Show file tree
Hide file tree
Showing 4 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/0001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/typescript.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
2 changes: 1 addition & 1 deletion packages/swingset-runner/src/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit c4f6a03

Please sign in to comment.