From b981b4260dd5204a1b5c96dab36dbe98d9393e4d Mon Sep 17 00:00:00 2001 From: Brian Warner Date: Mon, 3 Apr 2017 18:53:10 -0700 Subject: [PATCH] docs: reminder that welcome_handler may be called multiple times --- docs/api.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/api.md b/docs/api.md index 12aad01..2b63f55 100644 --- a/docs/api.md +++ b/docs/api.md @@ -352,7 +352,9 @@ supplied as an argument to the `wormhole()` constructor. This function will be called with the full welcome dictionary, so any other keys that a future server might send will be available to it. If the welcome handler raises `WelcomeError`, the connection will be closed just as if an `error` key had -been received. +been received. The handler may be called multiple times (once per connection, +if the rendezvous connection is lost and then reestablished), so applications +should avoid presenting the user with redundant messages. The default welcome handler will print `motd` to stderr, and will ignore `current_cli_version`.