suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
2d7521c78c
racket/collects/scribblings/reference
History
Matthew Flatt 2d7521c78c racket/place/distributed: fix doc problems 
Various repairs --- especially to avoid duplicated prose.

Instead of

 @(define explain @t{Long explanation about X...})

 @defproc[(a ....) ....]{ .... @|explain| }
 @defproc[(b ....) ....]{ .... @|explain| }
 @defproc[(c ....) ....]{ .... @|explain| }

write

 @defproc[(a ....) ....]{ .... Long explanation about X ... }
 @defproc[(b ....) ....]{ .... X is like @racket[a].  }
 @defproc[(c ....) ....]{ .... X is like @racket[a].  }

Otherwise, a reader is forced to reverse-engineer the
abstraction underlying `a', `b', and `c'.
2012-05-20 14:11:17 -06:00
..
async-channels.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
block.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
booleans.scrbl Fix documentation for `implies'. 2012-04-12 16:28:52 -04:00
breaks.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
bytes.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
channels.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
chaperones.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
chars.scrbl intern strings, etc. only when making syntax objects, not in `read' 2011-12-14 16:03:44 -07:00
class.scrbl Add contracts to interface syntax & structures 2012-05-04 17:24:55 -04:00
cmdline.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
code-inspectors.scrbl remove syntax certificates; add syntax taints 2011-06-29 19:15:48 -06:00
collects.scrbl add #:fail' option to collection-file-path' and `collection-path' 2012-01-09 15:59:05 -07:00
concurrency.scrbl [Distributed Places] Docs clean up part 1 2012-05-10 15:36:58 -06:00
cont-marks.scrbl Lots of documentation formatting. 2011-08-15 07:50:04 -04:00
cont.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
contracts-struct-prop.scrbl moved unstable/prop-contract into racket/contract/base 2011-12-18 13:57:50 -07:00
contracts.scrbl adjusted the contract error messages so that the words expected/promised 2012-05-15 22:08:42 -05:00
control-lib.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
control.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
custodians.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
custom-ports.scrbl remove built-in reader and printing support for Honu 2011-10-05 09:40:27 -06:00
custom-write.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
data.scrbl fix docs for `box-cas!', fix JITted version to check mutability 2012-05-03 21:38:36 -06:00
debugging.scrbl change `eval-jit-enabled' initialization 2011-07-27 07:55:05 +01:00
define-struct.scrbl clarify `define-struct/derived' in docs 2011-09-03 13:21:38 -06:00
dicts.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
distributed.scrbl racket/place/distributed: fix doc problems 2012-05-20 14:11:17 -06:00
ellipses-defn.rkt rename all files .ss -> .rkt 2010-04-27 16:50:15 -06:00
ellipses.rkt ".ss" -> ".rkt" scan done. 2011-07-02 10:37:53 -04:00
encodings.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
enter.scrbl fix typo; eliminate "this" as a noun; otherminor improvements 2011-07-14 21:32:47 -06:00
eval-model.scrbl first cut at submodules 2012-03-09 10:34:56 -07:00
eval.scrbl progress on submodule docs; bug fixes 2012-03-09 10:34:56 -07:00
evts.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
exit.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
exns.scrbl add date*' and exn:fail:syntax:unbound' 2011-09-29 09:22:10 -06:00
extras.css major Scribble revision (v4.2.1.2) 2009-07-25 20:25:33 +00:00
extras.tex major Scribble revision (v4.2.1.2) 2009-07-25 20:25:33 +00:00
fasl.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
file-ports.scrbl doc and terminology fix 2012-02-26 22:13:02 -05:00
filesystem.scrbl add a #:build?' argument to directory-list' 2012-05-16 09:43:23 -06:00
fixnums.scrbl Lots of documentation formatting. 2011-08-15 07:50:04 -04:00
flonums.scrbl racket/flonum: add `flexpt' 2012-05-07 20:41:14 -06:00
for.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
futures.scrbl Clarified futures-enabled? documentation 2012-02-12 20:42:05 -06:00
hashes.scrbl add cross-reference between data and read/print descriptions 2011-10-15 07:20:33 -07:00
help.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
include.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
info.rkt docs reorganization 2011-07-01 17:16:53 -06:00
init.scrbl Big newline at EOF scan. 2012-02-29 00:28:11 -05:00
io.scrbl Add pointers to the Guide in Reference docs. 2012-05-01 14:57:14 -04:00
load-lang.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
logging.scrbl add `log-max-level' 2012-02-26 22:13:02 -05:00
macros.scrbl Add pointers to the Guide in Reference docs. 2012-05-01 14:57:14 -04:00
match-grammar.rkt ".ss" -> ".rkt" scan done. 2011-07-02 10:37:53 -04:00
match-parse.rkt Finish converting scheme' -> racket'. 2011-06-28 00:45:38 -04:00
match.scrbl fix doc example 2012-05-13 06:57:44 -06:00
memory.scrbl docs: will executors are synchronizable events 2012-04-15 05:37:35 -06:00
model.scrbl move Reference reader & prnter docs to the model chapel 2011-08-28 18:15:43 -06:00
module-reflect.scrbl fix some doc contracts for submodules 2012-05-07 14:46:13 -06:00
mpairs.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
mz.rkt add cross-reference between data and read/print descriptions 2011-10-15 07:20:33 -07:00
namespaces.scrbl add `variable-reference->module-path-index' 2012-05-14 21:57:09 -06:00
networking.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
numbers.scrbl fix example 2012-05-15 20:11:42 -06:00
os.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
package.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
pairs.scrbl remove sfi links from the Reference 2012-05-13 06:57:44 -06:00
parameters.scrbl Lots of documentation formatting. 2011-08-15 07:50:04 -04:00
paths.scrbl add a #:build?' argument to directory-list' 2012-05-16 09:43:23 -06:00
pipes.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
places.scrbl Allow hashes across place channels. 2012-02-27 10:11:04 -07:00
port-buffers.scrbl reference clarifications on string ports 2011-11-26 17:09:23 -07:00
port-lib.scrbl fix the module reader for the case when there are non-ASCII unicode characters 2011-11-03 17:13:17 -05:00
port-line-counting.scrbl remove built-in reader and printing support for Honu 2011-10-05 09:40:27 -06:00
port-procs.scrbl add `port-closed-evt' 2011-11-10 10:01:57 -07:00
ports.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
pretty-print.scrbl add `port-set-next-location!'; make prompt read handler use it 2011-07-10 08:36:47 -06:00
printer.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
procedures.scrbl try to improve docs for `make-keyword-procedure' 2012-03-31 07:45:53 -06:00
prog-steps.rkt A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
promise.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
prop-port.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
read.scrbl intern strings, etc. only when making syntax objects, not in `read' 2011-12-14 16:03:44 -07:00
reader-example.rkt fix reader graph-notation equivalence 2011-08-18 12:54:52 -06:00
reader.scrbl extend string-literal syntax to allow surrogate-style \u pairs 2012-03-12 21:03:20 -06:00
readtables.scrbl remove built-in reader and printing support for Honu 2011-10-05 09:40:27 -06:00
reference.scrbl docs reorganization 2011-07-01 17:16:53 -06:00
regexps.scrbl Rename #:gap-select' -> #:gap-select?' and some minor doc fixes. 2012-04-17 15:56:10 -04:00
rmpi.scrbl racket/place/distributed: fix doc problems 2012-05-20 14:11:17 -06:00
running.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
runtime.scrbl change `eval-jit-enabled' initialization 2011-07-27 07:55:05 +01:00
rx.rkt Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
sandbox.scrbl racket/sandbox: use `gui-available?' at sandbox creation 2012-03-02 07:47:16 -07:00
security-guards.scrbl fix typo 2011-12-31 06:32:13 -07:00
security.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
semaphores.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
sequences.scrbl documentation clarification 2012-03-29 06:46:58 -06:00
serialization.scrbl add date*' and exn:fail:syntax:unbound' 2011-09-29 09:22:10 -06:00
sets.scrbl Doc fixes. 2012-04-30 14:13:32 -04:00
shared.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
splicing.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
startup.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
string-input.scrbl add `port-closed-evt' 2011-11-10 10:01:57 -07:00
string-output.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
string-ports.scrbl reference clarifications on string ports 2011-11-26 17:09:23 -07:00
strings.scrbl remove sfi links from the Reference 2012-05-13 06:57:44 -06:00
struct-inspectors.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
struct.scrbl Started on random testing for contracts 2011-11-23 22:54:21 -06:00
stx-certs.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
stx-comp.scrbl allow different phases for `free-identifier=?' arguments 2011-09-12 17:08:50 -06:00
stx-expand.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
stx-ops.scrbl allow #f as shift for `syntax-shift-phase-level' 2012-05-12 00:55:12 -06:00
stx-param.scrbl Lots of documentation formatting. 2011-08-15 07:50:04 -04:00
stx-patterns.scrbl fix docs for `syntax-id-rules' 2012-01-29 06:50:35 -07:00
stx-props.scrbl remove built-in reader and printing support for Honu 2011-10-05 09:40:27 -06:00
stx-taints.scrbl remove syntax certificates; add syntax taints 2011-06-29 19:15:48 -06:00
stx-trans.scrbl add "alias" and "converted-arguments-variant" properties 2012-05-17 10:58:22 -06:00
subprocess.scrbl add note about find-executable-path' to subprocess', etc. 2012-05-16 09:43:23 -06:00
surrogate.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
symbols.scrbl intern literal strings, byte strings, regexps, characters, and numbers 2011-11-22 08:54:37 -07:00
sync.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
syntax-model.scrbl doc layout repair 2012-05-20 07:39:05 -06:00
syntax-util.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
syntax.scrbl add "alias" and "converted-arguments-variant" properties 2012-05-17 10:58:22 -06:00
thread-cells.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
thread-groups.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
thread-local.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
threads.scrbl dc clarification on `thread-suspend' 2011-06-20 14:46:14 -06:00
time.scrbl remove sfi links from the Reference 2012-05-13 06:57:44 -06:00
trace.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
units.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
unix-paths.scrbl Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files. 2011-06-20 04:27:14 -04:00
unsafe.scrbl racket/flonum: add `flexpt' 2012-05-07 20:41:14 -06:00
values.scrbl A ton of @scheme*' -> @racket*' and related updates. 2011-06-25 04:08:47 -04:00
vectors.scrbl add cross-reference between data and read/print descriptions 2011-10-15 07:20:33 -07:00
windows-paths.scrbl Fixes spelling errors in reference. 2012-02-21 14:21:43 -05:00
write.scrbl change `current-write-relative-directory' to support more path conversions 2012-02-10 06:17:18 -07:00