suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix GUI and Reference doc typos

Browse Source
This commit is contained in:
Asumu Takikawa 2011-06-13 17:57:21 -04:00
parent 01a987bf5e
commit ed590b8ec5
6 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
collects/scribblings/gui/dialog-funcs.scrbl
View File

@ -183,7 +183,7 @@ See also @scheme[path-dialog%].
} }
@defproc[(message-box [title label-string?] @defproc[(message-box [title label-string?]
[message string] [message string?]
[parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f] [parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f]
[style (listof (or/c 'ok 'ok-cancel 'yes-no 'caution 'stop)) '(ok)]) [style (listof (or/c 'ok 'ok-cancel 'yes-no 'caution 'stop)) '(ok)])
(or/c 'ok 'cancel 'yes 'no)]{ (or/c 'ok 'cancel 'yes 'no)]{
@ -319,7 +319,7 @@ The @racket[message-box/custom] function can be called int a thread
current thread blocks while the dialog runs on the handler thread.} current thread blocks while the dialog runs on the handler thread.}
@defproc[(message+check-box [title label-string?] @defproc[(message+check-box [title label-string?]
[message string] [message string?]
[check-label label-string?] [check-label label-string?]
[parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f] [parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f]
[style (listof (or/c 'ok 'ok-cancel 'yes-no [style (listof (or/c 'ok 'ok-cancel 'yes-no
@ -367,7 +367,7 @@ Like @scheme[message-box/custom], except that
} }
@defproc[(get-text-from-user [title string] @defproc[(get-text-from-user [title string?]
[message (or/c string? #f)] [message (or/c string? #f)]
[parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f] [parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f]
[init-val string? ""] [init-val string? ""]
@ -391,7 +391,7 @@ If @scheme[style] includes @scheme['password], the dialog's text field
} }
@defproc[(get-choices-from-user [title string] @defproc[(get-choices-from-user [title string?]
[message (or/c string? #f)] [message (or/c string? #f)]
[choices (listof string?)] [choices (listof string?)]
[parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f] [parent (or/c (is-a?/c frame%) (is-a?/c dialog%) #f) #f]

6
collects/scribblings/gui/editor-funcs.scrbl
View File

@ -196,7 +196,7 @@ Returns @racket[#t] if @litchar{m:} corresponds to Command,
} }
@defproc[(open-input-graphical-file [filename string?]) @defproc[(open-input-graphical-file [filename string?])
input-port]{ input-port?]{
Opens @racket[filename] (in @racket['binary] mode) and checks whether it looks Opens @racket[filename] (in @racket['binary] mode) and checks whether it looks
like a ``graphical'' file in editor format. If the file does not like a ``graphical'' file in editor format. If the file does not
@ -210,7 +210,7 @@ Opens @racket[filename] (in @racket['binary] mode) and checks whether it looks
@defproc[(open-input-text-editor [text-editor (is-a?/c text%)] @defproc[(open-input-text-editor [text-editor (is-a?/c text%)]
[start-position exact-nonnegative-integer? 0] [start-position exact-nonnegative-integer? 0]
[end-position (or/c exact-nonnegative-integer? (one/of 'end)) 'end] [end-position (or/c exact-nonnegative-integer? 'end) 'end]
[snip-filter ((is-a?/c snip%) . -> . any/c) (lambda (s) s)] [snip-filter ((is-a?/c snip%) . -> . any/c) (lambda (s) s)]
[port-name any/c text-editor] [port-name any/c text-editor]
[expect-to-read-all? any/c #f] [expect-to-read-all? any/c #f]
@ -354,7 +354,7 @@ If @racket[raise-errors?] is true, then an error in reading triggers an
} }
@defproc[(text-editor-load-handler [filename path string] @defproc[(text-editor-load-handler [filename path string]
[expected-module-name (or/c symbol false/c)]) [expected-module-name (or/c symbol? #f)])
any/c]{ any/c]{
This procedure is a load handler for use with @racket[current-load]. This procedure is a load handler for use with @racket[current-load].

8
collects/scribblings/gui/eventspace-funcs.scrbl
View File

@ -4,7 +4,7 @@
@title[#:tag "eventspace-funcs"]{Eventspaces} @title[#:tag "eventspace-funcs"]{Eventspaces}
@defproc[(make-eventspace) @defproc[(make-eventspace)
eventspace]{ eventspace?]{
Creates and returns a new eventspace value. The new eventspace is Creates and returns a new eventspace value. The new eventspace is
created as a child of the current eventspace. The eventspace is used created as a child of the current eventspace. The eventspace is used
by making it the current eventspace with the by making it the current eventspace with the
@ -215,7 +215,7 @@ Blocks for at least the specified number of seconds, handling events
} }
@defproc[(eventspace-shutdown? [e eventspace]) @defproc[(eventspace-shutdown? [e eventspace?])
boolean?]{ boolean?]{
Returns @scheme[#t] if the given eventspace has been shut down by its Returns @scheme[#t] if the given eventspace has been shut down by its
custodian, @scheme[#f] otherwise. Attempting to create a new window, custodian, @scheme[#f] otherwise. Attempting to create a new window,
@ -229,8 +229,8 @@ Attempting to use certain methods of windows and timers in a shut-down
} }
@defproc[(eventspace-handler-thread [e eventspace]) @defproc[(eventspace-handler-thread [e eventspace?])
(or/c thread false/c)]{ (or/c thread #f)]{
Returns the handler thread of the given eventspace. If the handler Returns the handler thread of the given eventspace. If the handler
thread has terminated (e.g., because the eventspace was shut down), the thread has terminated (e.g., because the eventspace was shut down), the
result is @scheme[#f]. result is @scheme[#f].

4
collects/scribblings/gui/global-draw-funcs.scrbl
View File

@ -21,7 +21,7 @@ Returns the depth of the main display (a value of 1 denotes a monochrome display
} }
@defproc[(get-display-left-top-inset [avoid-bars? bool #f]) @defproc[(get-display-left-top-inset [avoid-bars? any/c #f])
(values exact-nonnegative-integer? exact-nonnegative-integer?)]{ (values exact-nonnegative-integer? exact-nonnegative-integer?)]{
When the optional argument is @scheme[#f] (the default), this function When the optional argument is @scheme[#f] (the default), this function
@ -37,7 +37,7 @@ When the optional argument is true, this function returns the amount
} }
@defproc[(get-display-size [full-screen? bool #f]) @defproc[(get-display-size [full-screen? any/c #f])
(values exact-nonnegative-integer? exact-nonnegative-integer?)]{ (values exact-nonnegative-integer? exact-nonnegative-integer?)]{
@index["screen resolution"]{Gets} the physical size of the display in @index["screen resolution"]{Gets} the physical size of the display in

14
collects/scribblings/gui/miscwin-funcs.scrbl
View File

@ -37,13 +37,13 @@ Rings the system bell.
See @racket[begin-busy-cursor]. See @racket[begin-busy-cursor].
} }
@defproc*[([(file-creator-and-type [filename path] @defproc*[([(file-creator-and-type [filename path?]
[creator-string (lambda (s) (and (bytes? s) [creator-string (lambda (s) (and (bytes? s)
(= 4 (bytes-length s))))] (= 4 (bytes-length s))))]
[type-bytes (lambda (s) (and (bytes? s) [type-bytes (lambda (s) (and (bytes? s)
(= 4 (bytes-length s))))]) (= 4 (bytes-length s))))])
void?] void?]
[(file-creator-and-type [filename path]) [(file-creator-and-type [filename path?])
(values (lambda (s) (and (bytes? s) (values (lambda (s) (and (bytes? s)
(= 4 (bytes-length s)))) (= 4 (bytes-length s))))
(lambda (s) (and (bytes? s) (lambda (s) (and (bytes? s)
@ -128,7 +128,7 @@ Returns the color that is used to draw selected text or @racket[#f] if
selected text is drawn with its usual color.} selected text is drawn with its usual color.}
@defproc[(get-window-text-extent [string string] @defproc[(get-window-text-extent [string string?]
[font (is-a?/c font%)] [font (is-a?/c font%)]
[combine? any/c #f]) [combine? any/c #f])
(values exact-nonnegative-integer? (values exact-nonnegative-integer?
@ -141,7 +141,7 @@ argument is as for @xmethod[dc<%> get-text-extent].
See also @xmethod[dc<%> get-text-extent]. See also @xmethod[dc<%> get-text-extent].
} }
@defproc[(graphical-read-eval-print-loop [eval-eventspace eventspace #f] @defproc[(graphical-read-eval-print-loop [eval-eventspace (or/c eventspace? #f) #f]
[redirect-ports? any/c (not eval-eventspace)]) [redirect-ports? any/c (not eval-eventspace)])
void?]{ void?]{
@ -213,7 +213,7 @@ Returns @racket[#t] if a busy cursor has been installed with
@racket[end-busy-cursor]. @racket[end-busy-cursor].
} }
@defproc[(label->plain-label [label string]) string?]{ @defproc[(label->plain-label [label string?]) string?]{
Strips shortcut ampersands from @racket[label], removes parenthesized Strips shortcut ampersands from @racket[label], removes parenthesized
ampersand--character combinations along with any surrounding space, ampersand--character combinations along with any surrounding space,
@ -226,7 +226,7 @@ Strips shortcut ampersands from @racket[label], removes parenthesized
@defproc[(make-gl-bitmap [width exact-positive-integer?] @defproc[(make-gl-bitmap [width exact-positive-integer?]
[height exact-positive-integer?] [height exact-positive-integer?]
[config (is-a?/c gl-config%)]) [config (is-a?/c gl-config%)])
(is-a/c? bitmap%)]{ (is-a?/c bitmap%)]{
Creates a bitmap that supports both normal @racket[dc<%>] drawing an Creates a bitmap that supports both normal @racket[dc<%>] drawing an
OpenGL drawing through a context returned by @xmethod[dc<%> get-gl-context]. OpenGL drawing through a context returned by @xmethod[dc<%> get-gl-context].
@ -252,7 +252,7 @@ environment of the result namespace.}
@defproc[(make-screen-bitmap [width exact-positive-integer?] @defproc[(make-screen-bitmap [width exact-positive-integer?]
[height exact-positive-integer?]) [height exact-positive-integer?])
(is-a/c? bitmap%)]{ (is-a?/c bitmap%)]{
Creates a bitmap that draws in a way that is the same as drawing to a Creates a bitmap that draws in a way that is the same as drawing to a
canvas in its default configuration. canvas in its default configuration.

2
collects/scribblings/reference/exns.scrbl
View File

@ -385,7 +385,7 @@ To report a run-time error, use @racket[raise] or procedures like
@racket[error], instead of calling the error display handler @racket[error], instead of calling the error display handler
directly.} directly.}
@defparam[error-print-width width (and exact-integer? (>=/c 3))]{ @defparam[error-print-width width (and/c exact-integer? (>=/c 3))]{
A parameter whose value is used as the maximum number of characters A parameter whose value is used as the maximum number of characters
used to print a Racket value that is embedded in a primitive error used to print a Racket value that is embedded in a primitive error