open.source/magic-wormhole
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: fix typos

Browse Source
This commit is contained in:
Jakub Wilk 2018-11-03 15:38:58 +01:00
parent 0eaba64718
commit 24836cea63
3 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/api.md
View File

@ -5,7 +5,7 @@ of data between two computers. Both machines must be connected to the
internet, but they do not need to have public IP addresses or know how to
contact each other ahead of time.
Security and connectivity is provided by means of an "wormhole code": a short
Security and connectivity is provided by means of a "wormhole code": a short
string that is transcribed from one machine to the other by the users at the
keyboard. This works in conjunction with a baked-in "rendezvous server" that
relays information from one machine to the other.
@ -220,7 +220,7 @@ The code-entry Helper object has the following API:
"opulent-prowler"}` (note the lack of a trailing hyphen, because the
wordlist is expecting a code of length two). If the wordlist is not yet
known, this returns an empty set. All return values will
`.startwith(prefix)`. The frontend is responsible for sorting the results
`.startswith(prefix)`. The frontend is responsible for sorting the results
before display.
* `h.choose_words(words)`: call this when the user is finished typing in the
code. It does not return anything, but will cause the Wormhole's

2
docs/journal.md
View File

@ -23,7 +23,7 @@ Applications written in this style must follow some strict rules:
* the only way to affect the state is by processing an input message
* event processing is deterministic (any non-determinism must be implemented
as a message, e.g. from a clock service or a random-number generator)
* apps must never forget a message for which they've accepted reponsibility
* apps must never forget a message for which they've accepted responsibility
The main processing function takes the previous state checkpoint and a single
input message, and produces a new state checkpoint and a set of output

2
docs/server-protocol.md
View File

@ -155,7 +155,7 @@ The `open` command both marks the mailbox as being opened by the bound side,
and also adds the WebSocket as subscribed to that mailbox, so new messages
are delivered immediately to the connected client. There is no explicit ack
to the `open` command, but since all clients add a message to the mailbox as
soon as they connect, there will always be a `message` reponse shortly after
soon as they connect, there will always be a `message` response shortly after
the `open` goes through. The `close` command provokes a `closed` response.
The `close` command accepts an optional "mood" string: this allows clients to