From 923ec1742f0ec587b0e7f1e33b91b8c43f17ca58 Mon Sep 17 00:00:00 2001 From: Matthew Butterick Date: Sat, 22 Feb 2014 15:40:45 -0800 Subject: [PATCH] update docs for safe mode --- hyphenate/scribblings/hyphenate.scrbl | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/hyphenate/scribblings/hyphenate.scrbl b/hyphenate/scribblings/hyphenate.scrbl index dabea200..ee1ea70e 100644 --- a/hyphenate/scribblings/hyphenate.scrbl +++ b/hyphenate/scribblings/hyphenate.scrbl @@ -22,10 +22,16 @@ At the command line: After that, you can update the package like so: @verbatim{raco pkg update hyphenate} +@section{Importing the module} -@section{Interface} +@defmodule[#:multi (hyphenate (submod hyphenate safe))] + +The module operates in two modes: fast and safe. Fast mode is the default, which you get by importing the module in the usual way: @code{(require hyphenate)}. + +Safe mode enables the function contracts documented below. Use safe mode by importing the module as @code{(require (submod hyphenate safe))}. -@defmodule[hyphenate] + +@section{Interface} @defproc[ (hyphenate