added docs and contract for preferences:get-preference/gui

This commit is contained in:
Robby Findler 2011-01-22 07:43:57 -06:00
parent 45a635339e
commit db13cddef0

View File

@ -192,6 +192,19 @@
any preference save eventually succeeds, all of the past failures any preference save eventually succeeds, all of the past failures
are also written at that point.}]}) are also written at that point.}]})
(proc-doc/names
preferences:get-preference/gui
(->* (symbol?)
((-> void?))
any/c)
((sym)
((default (λ () (error 'get-preference/gui "unknown pref ~s" sym)))))
@{Like @scheme[get-preference], but has more sophisticated error handling.
In particular, it passes a @racket[#:timeout-lock-there] argument that
informs the user that the preferences file is locked (and offers the alternative
of not showing the message again).})
(proc-doc/names (proc-doc/names
preferences:add-panel preferences:add-panel
(-> (or/c string? (cons/c string? (listof string?))) (-> (or/c string? (cons/c string? (listof string?)))