From d85b66536f2a29012feb874eeb7f8acbf51dbb4c Mon Sep 17 00:00:00 2001 From: Slava Pestov Date: Sat, 22 Aug 2009 17:45:18 -0500 Subject: [PATCH] Add docs for break and B words --- basis/tools/continuations/continuations-docs.factor | 6 ++++++ basis/tools/walker/walker-docs.factor | 5 +++++ basis/ui/tools/walker/walker-docs.factor | 1 + 3 files changed, 12 insertions(+) create mode 100644 basis/tools/continuations/continuations-docs.factor create mode 100644 basis/tools/walker/walker-docs.factor diff --git a/basis/tools/continuations/continuations-docs.factor b/basis/tools/continuations/continuations-docs.factor new file mode 100644 index 0000000000..bd69fb48ca --- /dev/null +++ b/basis/tools/continuations/continuations-docs.factor @@ -0,0 +1,6 @@ +IN: tools.continuations +USING: help.markup help.syntax ; + +HELP: break +{ $description "A breakpoint. When this word is executed, the walker tool opens with execution suspended at the breakpoint's location." } +{ $see-also "ui-walker" } ; \ No newline at end of file diff --git a/basis/tools/walker/walker-docs.factor b/basis/tools/walker/walker-docs.factor new file mode 100644 index 0000000000..b636760634 --- /dev/null +++ b/basis/tools/walker/walker-docs.factor @@ -0,0 +1,5 @@ +IN: tools.walker +USING: help.syntax help.markup tools.continuations ; + +HELP: B +{ $description "An alias for " { $link break } ", defined in the " { $vocab-link "syntax" } " vocabulary so that it is always available." } ; \ No newline at end of file diff --git a/basis/ui/tools/walker/walker-docs.factor b/basis/ui/tools/walker/walker-docs.factor index 9e73a31282..ce354da268 100644 --- a/basis/ui/tools/walker/walker-docs.factor +++ b/basis/ui/tools/walker/walker-docs.factor @@ -28,6 +28,7 @@ ARTICLE: "breakpoints" "Setting breakpoints" $nl "Breakpoints can be inserted directly into code:" { $subsection break } +{ $subsection POSTPONE: B } "Note that because the walker calls various core library and UI words while rendering its own user interface, setting a breakpoint on a word such as " { $link append } " or " { $link draw-gadget } " will hang the UI." ; ARTICLE: "ui-walker" "UI walker"