From f78c5b4d207247f2027347818d8b0c86f9552d65 Mon Sep 17 00:00:00 2001 From: Slava Pestov Date: Thu, 13 Nov 2008 23:35:00 -0600 Subject: [PATCH] Write furnace.db docs --- basis/furnace/db/db-docs.factor | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/basis/furnace/db/db-docs.factor b/basis/furnace/db/db-docs.factor index 367a806d36..a7ef02b77f 100644 --- a/basis/furnace/db/db-docs.factor +++ b/basis/furnace/db/db-docs.factor @@ -1,20 +1,16 @@ -! Copyright (C) 2008 Your name. -! See http://factorcode.org/license.txt for BSD license. -USING: help.markup help.syntax io.streams.string ; +USING: help.markup help.syntax db http.server ; IN: furnace.db HELP: { $values - { "responder" null } { "db" null } - { "responder'" null } + { "responder" "a responder" } { "db" db } + { "responder'" db-persistence } } -{ $description "" } ; - -HELP: db-persistence -{ $description "" } ; +{ $description "Wraps a responder with database persistence support. The responder's " { $link call-responder* } " method will run in a " { $link with-db } " scope." } ; ARTICLE: "furnace.db" "Furnace database support" -{ $vocab-link "furnace.db" } -; +"The " { $vocab-link "furnace.db" } " vocabulary implements a responder which maintains a database connection pool and runs each request in a " { $link with-db } " scope." +{ $subsection } +"The " { $vocab-link "furnace.alloy" } " vocabulary combines database persistence with several other features." ; ABOUT: "furnace.db"