commit 531ad440b75b189a2b0838aab011544d44d6b580
parent 37019a1eb69e9a9268e1ae9a891b9b7bfe4f5f49
Author: Robby Findler <robby@racket-lang.org>
Date: Wed, 4 Jan 2017 09:18:00 -0600
add dictat about predicates as nouns
Diffstat:
1 file changed, 11 insertions(+), 0 deletions(-)
diff --git a/scribble-doc/scribblings/scribble/style.scrbl b/scribble-doc/scribblings/scribble/style.scrbl
@@ -64,6 +64,17 @@ or ``the X11 windowing system'' would be more precisely correct, but
use ``X11'' as adjective when necessary, such as ``X11 display.''
Racket runs ``on'' a platform, as opposed to ``under'' a platform.
+Avoid using a predicate as a noun that stands for a value
+satisfying the predicate. Instead, use @racket[tech] and
+@racket[deftech] to establish a connection between an
+English word or phrase that describes the class of values
+and the predicate (or
+@tech[#:doc '(lib "scribblings/reference/reference.scrbl")]{
+ contract}). For example, avoid ``supply a
+@racket[path-string?]''; prefer ``supply a
+@tech[#:doc '(lib "scribblings/reference/reference.scrbl")]{
+ path or string}.''
+
@section{Typesetting Code}