Get rid of "defaultly"s.

This commit is contained in:
Eli Barzilay 2011-06-28 02:11:24 -04:00
parent 40124a0619
commit 78dacef817
14 changed files with 72 additions and 73 deletions

View File

@ -252,7 +252,7 @@ The @litchar{MZSCHEME} forms are disabled unless the web page is a
@defmethod[(reload) void?]{
Reloads the current page.
The text defaultly uses the basic style named
By default, the text uses the basic style named
@racket["Html Standard"] in the editor (if it exists).
}
@ -339,7 +339,7 @@ The @litchar{MZSCHEME} forms are disabled unless the web page is a
}
@defmethod[(after-set-page) void?]{
Called during @racket[set-page]. Defaultly does nothing.
Called during @racket[set-page]. Does nothing by default.
}
}

View File

@ -806,8 +806,8 @@ all of the names in the tools library, for use defining keybindings
@{Returns a keymap that binds various DrRacket-specific
keybindings. This keymap is used in the definitions
and interactions window.
Defaultly binds C-x;o to a function that switches
By default, binds C-x;o to a function that switches
the focus between the definitions and interactions
windows. Also binds f5 to Execute and f1 to Help Desk.})
@ -1211,69 +1211,68 @@ all of the names in the tools library, for use defining keybindings
"--- " desc ...)])])
(itemize
@cap[drracket:check-syntax-button boolean? #t]{controls the visiblity of the check syntax button}
@cap[drracket:language-menu-title
string?
@cap[drracket:language-menu-title string?
(string-constant scheme-menu-name)]{
controls the name of the menu just to the right of the language
menu (defaultly named ``Racket'')}
controls the name of the menu just to the right of the language
menu (named ``Racket'' by default)}
@cap[drscheme:define-popup
(or/c #f
(list/c string? string? string?)
(cons/c string? string?))
(list "(define" "(define ...)" "δ")]{
specifies the prefix that the define popup should look for and what
label it should have, or @racket[#f] if it should not appear at all.
If the list of three strings alternative is used, the first string is
the prefix that is looked for when finding definitions. The second
and third strings are used as the label of the control, in horizontal
and vertical mode, respectively.
The pair of strings alternative is deprecated. If it is used,
the pair @racket[(cons a-str b-str)] is the same as @racket[(list a-str b-str "δ")].}
specifies the prefix that the define popup should look for and what
label it should have, or @racket[#f] if it should not appear at all.
If the list of three strings alternative is used, the first string is
the prefix that is looked for when finding definitions. The second
and third strings are used as the label of the control, in horizontal
and vertical mode, respectively.
The pair of strings alternative is deprecated. If it is used,
the pair @racket[(cons a-str b-str)] is the same as @racket[(list a-str b-str "δ")].}
@cap[drscheme:help-context-term (or/c false/c string?) #f]{
specifies a context query for documentation searches that are
initiated in this language, can be @racket[#f] (no change to the
user's setting) or a string to be used as a context query (note: the
context is later maintained as a cookie, @racket[""] is different
from @racket[#f] in that it clears the stored context)}
specifies a context query for documentation searches that are
initiated in this language, can be @racket[#f] (no change to the
user's setting) or a string to be used as a context query (note: the
context is later maintained as a cookie, @racket[""] is different
from @racket[#f] in that it clears the stored context)}
@cap[drscheme:special:insert-fraction boolean? #t]{
determines if the insert fraction menu item in the special menu is
visible}
determines if the insert fraction menu item in the special menu is
visible}
@cap[drscheme:special:insert-lambda boolean? #t]{
determines if the insert lambda menu item in the special menu is
visible}
determines if the insert lambda menu item in the special menu is
visible}
@cap[drscheme:special:insert-large-letters boolean? #t]{
determines if the insert large letters menu item in the special menu
is visible}
determines if the insert large letters menu item in the special menu
is visible}
@cap[drscheme:special:insert-image boolean? #t]{
determines if the insert image menu item in the special menu is
visible}
determines if the insert image menu item in the special menu is
visible}
@cap[drscheme:special:insert-comment-box boolean? #t]{
determines if the insert comment box menu item in the special menu
is visible}
determines if the insert comment box menu item in the special menu
is visible}
@cap[drscheme:special:insert-gui-tool boolean? #t]{
determines if the insert gui menu item in the special menu is
visible}
determines if the insert gui menu item in the special menu is
visible}
@cap[drscheme:special:slideshow-menu-item boolean? #t]{
determines if the insert pict box menu item in the special menu is
visible}
determines if the insert pict box menu item in the special menu is
visible}
@cap[drscheme:special:insert-text-box boolean? #t]{
determines if the insert text box menu item in the special menu is
visible}
determines if the insert text box menu item in the special menu is
visible}
@cap[drscheme:special:xml-menus boolean? #t]{
determines if the insert scheme box, insert scheme splice box, and
the insert xml box menu item in the special menu are visible}
determines if the insert scheme box, insert scheme splice box, and
the insert xml box menu item in the special menu are visible}
@cap[drscheme:autocomplete-words (listof string?) '()]{
determines the list of words that are used when completing words in
this language}
determines the list of words that are used when completing words in
this language}
@cap[drscheme:tabify-menu-callback
(or/c false/c (-> (is-a?/c text%) number? number? void?))
(λ (t a b) (send t tabify-selection a b))]{
is used as the callback when the ``Reindent'' or ``Reindent All''
menu is selected. The first argument is the editor, and the second
and third are a range in the editor.}
))})
is used as the callback when the ``Reindent'' or ``Reindent All''
menu is selected. The first argument is the editor, and the second
and third are a range in the editor.}
))})
(proc-doc/names
drracket:language:capability-registered?

View File

@ -20,9 +20,9 @@ to specify this class's behavior.
instance of decorated-editor-snip%. Override this when
deriving a new class from decorated-editor-snip%.
> make-editor :: (send a-des make-editor) - returns the
editor to be used in the snip. Defaultly returns an
instance of text%.
> make-editor :: (send a-des make-editor) - returns the
editor to be used in the snip. Returns an instance of
text% by default.
> get-color :: (send a-des get-color) - returns a color%
object or a string in the color-database%

View File

@ -155,15 +155,15 @@
The result of this method is used as the class for creating
the menu items in this frame.
Defaultly returns @racket[menu:can-restore-menu-item].}))
(make-generic-method
Returns @racket[menu:can-restore-menu-item] by default.}))
(make-generic-method
'get-checkable-menu-item% '(λ () menu:can-restore-checkable-menu-item%)
(list
'@defmethod[(get-checkable-menu-item%) (is-a?/c menu:can-restore-checkable-menu-item%)]{
The result of this method is used as the class for creating
checkable menu items in this class.
Defaultly returns @racket[menu:can-restore-checkable-menu-item].}))
returns @racket[menu:can-restore-checkable-menu-item] by default.}))
(make-generic-method
'get-file-menu

View File

@ -90,7 +90,7 @@ If it receives false, the name message will not shrink and
its minimum width will be the size required to display its
current label.
Defaultly, the name-message does not allow shrinking.
By default, the name-message does not allow shrinking.
}
}

View File

@ -2114,7 +2114,7 @@ constructed directly with @racket[language]. If it is @racket[#f], then only
the last extension to the language is shown (with
four-period ellipses, just like in the concrete syntax).
Defaultly @racket[#f].
Defaults to @racket[#f].
Note that the @racket[#t] variant can look a little bit strange if
@racket[....] are used and the original version of the language has

View File

@ -204,7 +204,7 @@ appears at any time.
@item{@defmenuitem{Toolbar}
@itemize[
@item{@defmenuitem{Toolbar on Left} Moves the tool bar (defaultly on the top of DrRacket's window) to the left-hand side, organized vertically.}
@item{@defmenuitem{Toolbar on Left} Moves the tool bar (on the top of DrRacket's window by default) to the left-hand side, organized vertically.}
@item{@defmenuitem{Toolbar on Top} Moves the toolbar to the top of the DrRacket window.}
@item{@defmenuitem{Toolbar on Right} Moves the tool bar to the right-hand side, organized vertically.}
@item{@defmenuitem{Toolbar Hidden} Hides the toolbar entirely.}]}

View File

@ -281,7 +281,7 @@
See also @racket[editor:add-after-user-keymap].
Defaultly returns @racket[(list (keymap:get-user) (keymap:get-global))]
Returns @racket[(list (keymap:get-user) (keymap:get-global))] by default.
}
}
@defmixin[editor:keymap-mixin (editor:basic<%>) (editor:keymap<%>)]{
@ -315,7 +315,7 @@
The result of this method is used as the parent for the
dialog that asks about closing.
Defaultly returns @racket[#f].
Returns @racket[#f] by default.
}
@defmethod*[(((update-frame-filename) void?))]{
Attempts to find a frame that displays this editor. If it
@ -328,7 +328,7 @@
been saved is a reason to alert the user. See also
@method[editor:file-mixin can-close?].
Defaultly returns @racket[#f].
Returns @racket[#f] by default.
}
@defmethod[(user-saves-or-not-modified? [allow-cancel? #t]) boolean?]{

View File

@ -82,7 +82,7 @@
This returns the filename that the frame is currently being saved as,
or @racket[#f] if there is no appropriate filename.
Defaultly returns @racket[#f].
Returns @racket[#f] by default.
If @racket[temp] is a box, it is filled with @racket[#t] or @racket[#f],
depending if the filename is a temporary filename.
@ -647,7 +647,7 @@
When the user switches the visible file in this frame, the of this method
is the editor that gets switched.
Defaultly returns the result of @method[frame:editor<%> get-editor].
By Default, returns the result of @method[frame:editor<%> get-editor].
}
@defmethod*[(((open-here (filename string)) void?))]{

View File

@ -6,9 +6,9 @@
@(defmethod (get-menu%) (is-a?/c menu:can-restore-underscore-menu%) "The result of this method is used as the class" "\n" " " "for creating the result of these methods:" "\n" " " (method frame:standard-menus get-file-menu) "," "\n" " " (method frame:standard-menus get-edit-menu) ", and" "\n" " " (method frame:standard-menus get-help-menu) ".")
@(defmethod (get-menu-item%) (is-a?/c menu:can-restore-menu-item%) "The result of this method is used as the class for creating" "\n" "the menu items in this frame." "\n" "\n" "Defaultly returns " (racket menu:can-restore-menu-item) ".")
@(defmethod (get-menu-item%) (is-a?/c menu:can-restore-menu-item%) "The result of this method is used as the class for creating" "\n" "the menu items in this frame." "\n" "\n" "Returns " (racket menu:can-restore-menu-item) " by default.")
@(defmethod (get-checkable-menu-item%) (is-a?/c menu:can-restore-checkable-menu-item%) "The result of this method is used as the class for creating" "\n" "checkable menu items in this class." "\n" "\n" "Defaultly returns " (racket menu:can-restore-checkable-menu-item) ".")
@(defmethod (get-checkable-menu-item%) (is-a?/c menu:can-restore-checkable-menu-item%) "The result of this method is used as the class for creating" "\n" "checkable menu items in this class." "\n" "\n" "Returns " (racket menu:can-restore-checkable-menu-item) " by default.")
@(defmethod (get-file-menu) (is-a?/c menu%) "Returns the file menu." "\n" "See also " (method frame:standard-menus<%> get-menu%) ".")

View File

@ -100,7 +100,7 @@
this method to change the initial @racket[bitmap%]. See also @method[text%
set-autowrap-bitmap]
Defaultly returns the result of @racket[icon:get-autowrap-bitmap]
Returns the result of @racket[icon:get-autowrap-bitmap] by default.
}
@defmethod*[(((get-port-name) (or/c path-string? symbol? #f)))]{
@ -871,8 +871,8 @@
This method is called during the initialization of the class.
Defaultly returns @racket["text:ports out"] which is mapped to a blue style
in the style list returned by @racket[editor:get-standard-style-list].
By default, returns @racket["text:ports out"] which is mapped to a blue
style in the style list returned by @racket[editor:get-standard-style-list].
}
@defmethod*[(((get-err-style-delta) (or/c (is-a?/c style-delta%) string?)))]{
@ -885,8 +885,8 @@
This method is called during the initialization of the class.
Defaultly returns @racket["text:ports err"] which is mapped to a red italic
style in the style list returned by
By default, returns @racket["text:ports err"] which is mapped to a red
italic style in the style list returned by
@racket[editor:get-standard-style-list].
}
@ -901,7 +901,7 @@
This method is called during the initialization of the class.
Defaultly returns @racket["text:ports value"] which is mapped to a blue
By default, returns @racket["text:ports value"] which is mapped to a blue
style in the style list returned by
@racket[editor:get-standard-style-list].
}

View File

@ -135,7 +135,7 @@ to the user's browser.
}
@methimpl{
Defaultly returns the empty list.
Returns the empty list by default.
}}

View File

@ -405,7 +405,7 @@ interface.
@racket[#f], @racket[namespace-require] is used.
}
@methimpl{
Defaultly returns @racket[#f].
Returns @racket[#f] by default.
}}}
@ -467,7 +467,7 @@ DrRacket.
@racket[drracket:language:register-capability].
}
@methimpl{
Defaultly returns the value from:
By default, returns the value from:
@racket[drracket:language:get-capability-default].
}}

View File

@ -192,7 +192,7 @@ Like always, you don't even need to save the file.
as its continuation manager. (The default manager limits the amount of memory to 64 MB and
deals with memory pressure as discussed in the @racket[make-threshold-LRU-manager] documentation.)
The server files are rooted at @racket[server-root-path] (which is defaultly the distribution root.)
The server files are rooted at @racket[server-root-path] (which is the distribution root by default.)
File paths, in addition to the @filepath["htdocs"] directory under @racket[server-root-path] may be
provided with @racket[extra-files-paths]. These paths are checked first, in the order they appear in the list.