summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSamuel Williams <samuel.williams@oriontransfer.co.nz>2022-07-22 17:58:57 +1200
committerSamuel Williams <samuel.williams@oriontransfer.co.nz>2022-07-22 17:58:57 +1200
commit16342f562ceee101657fc9b7a175eb42914ee87b (patch)
treefd259ba38fd642c85efac837a392cf4f57e31797
parentfb87056a76cceb82af2c5f07d05029df61d54b39 (diff)
downloadrack-16342f562ceee101657fc9b7a175eb42914ee87b.tar.gz
Improved documentation for `Rack::Builder`.
-rw-r--r--lib/rack/builder.rb7
1 files changed, 4 insertions, 3 deletions
diff --git a/lib/rack/builder.rb b/lib/rack/builder.rb
index 05444f2c..fa5e876f 100644
--- a/lib/rack/builder.rb
+++ b/lib/rack/builder.rb
@@ -3,8 +3,10 @@
require_relative 'urlmap'
module Rack
- # Rack::Builder implements a small DSL to interactively construct Rack
- # applications.
+ # Rack::Builder provides a domain-specific language (DSL) to construct Rack
+ # applications. It is primarily used to parse +config.ru+ files which
+ # instantiate several middleware and a final application which are hosted
+ # by a Rack-compatible web server.
#
# Example:
#
@@ -31,7 +33,6 @@ module Rack
#
# +use+ adds middleware to the stack, +run+ dispatches to an application.
# You can use +map+ to construct a Rack::URLMap in a convenient way.
-
class Builder
# https://stackoverflow.com/questions/2223882/whats-the-difference-between-utf-8-and-utf-8-without-bom