From 6f42433c57ccb540f3c9d2038914feae73f77d97 Mon Sep 17 00:00:00 2001 From: Brian Warner Date: Mon, 28 May 2018 23:42:04 -0700 Subject: [PATCH] docs/api: minor rephrasings --- docs/api.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/api.md b/docs/api.md index 4361ec2..97fdbd7 100644 --- a/docs/api.md +++ b/docs/api.md @@ -141,10 +141,10 @@ optional arguments: ## Code Management Each wormhole connection is defined by a shared secret "wormhole code". These -codes can be generated offline (by picking a unique number and some secret -words), but are more commonly generated by whoever creates the first -wormhole. In the "bin/wormhole" file-transfer tool, the default behavior is -for the sender to create the code, and for the receiver to type it in. +codes can be created by humans offline (by picking a unique number and some +secret words), but are more commonly generated by asking the library to make +one. In the "bin/wormhole" file-transfer tool, the default behavior is for +the sender's program to create the code, and for the receiver to type it in. The code is a (unicode) string in the form `NNN-code-words`. The numeric "NNN" prefix is the "channel id" or "nameplate", and is a short integer @@ -161,7 +161,7 @@ The Wormhole object has three APIs for generating or accepting a code: * `w.allocate_code(length=2)`: this contacts the Rendezvous Server, allocates a short numeric nameplate, chooses a configurable number of random words, then assembles them into the code -* `w.set_code(code)`: this accepts the code as an argument +* `w.set_code(code)`: this accepts the complete code as an argument * `helper = w.input_code()`: this facilitates interactive entry of the code, with tab-completion. The helper object has methods to return a list of viable completions for whatever portion of the code has been entered so