commit 0bbee2d93e9dcf9fd1d23a9b66231c92b971e6f5
parent e34cf22278c83db6909e91848ca57b68bb2df3c6
Author: Matthew Flatt <mflatt@racket-lang.org>
Date: Wed, 12 Feb 2014 06:36:40 -0700
typos and notes
Thanks to Eli.
original commit: c64142ce24c3773eb4c3d4603588de286f1032d3
Diffstat:
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/html.scrbl b/pkgs/scribble-pkgs/scribble-doc/scribblings/scribble/html.scrbl
@@ -446,7 +446,7 @@ before @racket[renderer] is called.}
@defparam[url-roots roots (or/c #f
(listof (cons/c path-string?
(cons/c string?
- (listof 'abs 'index)))))]{
+ (listof (or/c 'abs 'index))))))]{
A parameter that determines how resource paths are converted to URLs
for reference. A @racket[#f] value is equivalent to an empty list.
@@ -460,8 +460,8 @@ all paths are expected to be disjoint (e.g., no @racket["/foo"] and
If an item in the parameter's list includes @racket['abs], then an
absolute URL is produced for all references to files with the
-corresponding prefix. If an item includes @racket['index], then an
-refer to a directory path is converted to a reference to
+corresponding prefix. If an item includes @racket['index], then a
+reference to a directory path is converted to a reference to
@filepath{index.html}, otherwise a reference to @filepath{index.html}
is converted to a directory path.}
diff --git a/pkgs/scribble-pkgs/scribble-html-lib/scribble/html/resource.rkt b/pkgs/scribble-pkgs/scribble-html-lib/scribble/html/resource.rkt
@@ -26,8 +26,10 @@
(require scribble/text)
-;; default file, urls to it will point to its directory instead, and a
-;; /-suffixed path will render to this file
+;; default file, urls to it will point to its directory instead, a
+;; /-suffixed path will render to this file, and `url-roots' entries
+;; with 'index will append this file name to a rewritten path that
+;; otherwise ends in /
(define default-file "index.html")
;; the currently rendered directory, as a list
