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

clarify materialize-user-docs docs

Browse Source
This commit is contained in:
Robby Findler 2014-11-24 09:27:30 -06:00
parent eb0f88939a
commit c11a83c1dd
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
pkgs/racket-pkgs/racket-doc/scribblings/raco/setup.scrbl
View File

@ -1664,10 +1664,14 @@ manuals that have been installed with @exec{raco setup}.}
void?]{ void?]{
Checks whether a user-specific documentation entry point already Checks whether a user-specific documentation entry point already
exists with @racket[(find-user-doc-dir)], and if not, runs @exec{raco exists in @racket[(find-user-doc-dir)], and if not, runs @exec{raco
setup} in a mode that will create the entry point (to have the same setup} in a mode that will create the entry point (to have the same
content as the installation's documentation entry point.) content as the installation's documentation entry point.)
The run of @exec{raco setup} is packaged in a thunk that is provided to The run of @exec{raco setup} is packaged in a thunk that is provided to
@racket[on-setup], which can adjust the current output and error ports @racket[on-setup], which can adjust the current output and error ports
as appropriate and check the thunk's result for success.} as appropriate and check the thunk's result for success.
The @racket[on-setup] argument is not called if the documentation entry
point already exists in @racket[(find-user-doc-dir)].
}