Commit Graph

124 Commits

Author SHA1 Message Date
Asumu Takikawa
b56574e4d5 scribble: add examples for most def* forms 2012-10-27 07:01:02 -04:00
Asumu Takikawa
be21153818 Fix typesetting of code:blank in the Scribble docs 2012-10-14 07:34:55 -04:00
Matthew Flatt
5e5e503859 scribble/manual: add #:normalize?' option to deftech' et al. 2012-08-20 17:37:24 -06:00
Matthew Flatt
1ca5767684 fix docs for `deftech': mention case folding 2012-08-20 17:37:19 -06:00
Robby Findler
8ee76c9547 Add index entries for @defconstructor (and friends). Also add
code that skips over them when building the search indices.
Overall, this means that the only change most people would see
is that multiple constructors in the same class will get a warning
(and there was one of those, so fixed that too).

Also, Rackety. Specifically, transformed this surprising combination
of constructs (where all caps are placeholders for something specific):

((if PRED
     (λ (c mk) BODY2)
     (λ (c mk) BODY1))
 content
 (lambda (tag) BODY3))

into this one:

(define (mk tag) BODY3)
(if PRED
    BODY1{c:=content}
    BODY2{c:=content})
2012-08-11 21:52:48 -05:00
Asumu Takikawa
9f83ba1c6f Fix doc typos 2012-07-03 15:54:25 -04:00
Matthew Flatt
4ed8a88969 doc correction
Closes PR 12844
2012-07-02 09:08:05 -06:00
Matthew Flatt
6028a60f65 scribble/manual: add #:id' option to defproc'
Also, convert the implementation of `defproc', `defform', etc. to
use `syntax-parse'.
2012-06-25 23:16:33 -06:00
Matthew Flatt
303aaec2b4 update docs related to definition-box labels 2012-06-21 07:15:09 +08:00
Matthew Flatt
5ff3087677 scribble: adjust `def...' box to show a background label in HTML
For example, a syntactic form box is labeled with "SYNTAX". Forms
such as `defform' and `defthing' now support a `#:kind' option
for setting the label.
2012-06-17 09:19:58 +08:00
Matthias Felleisen
9ef66b80ea add a form to declare a module/library deprecated 2012-04-28 13:25:32 -04:00
Matthew Flatt
c5e5a0349a add #:line-number-sep' to codeblock' 2012-04-11 11:49:01 -06:00
Matthew Flatt
ff41a896bc add ffi/com', ffi/unsafe/com' 2012-01-10 18:35:32 -07:00
Matthew Flatt
0b2beace40 add `schemecommentfont' 2011-09-03 14:57:57 -06:00
Eli Barzilay
0e31b37aa4 Documentation typo. 2011-08-29 15:13:01 -04:00
Matthew Flatt
099a0eebed improve codeblock' and racketblock' docs
including an explanation of the advantages and drawbacks of each
2011-08-16 08:02:50 -06:00
Matthew Flatt
4555254380 add code' to scribble/manual' 2011-08-16 07:53:05 -06:00
Matthew Flatt
a1eaecb337 add an #:escape' clause to all schemeblock'-like forms 2011-08-16 07:53:05 -06:00
Eli Barzilay
d61eb53686 Lots of documentation formatting.
Started as fixing misindented definitions, then more indentations, then
a bunch of similar things (square brackets, huge spaces at end-of-lines,
etc).
2011-08-15 07:50:04 -04:00
Matthew Flatt
f34c0329bf scribble/manual: add `current-display-width' parameter 2011-08-08 17:10:54 -06:00
Matthew Flatt
3ffa731f80 fix docs
Closes PR 12011
2011-08-02 17:07:39 -06:00
Matthew Flatt
e1b02e08f7 generalize `defform' & co. to better support abstraction 2011-07-07 10:45:43 -06:00
Matthew Flatt
5d06476cb3 scribble: clarify intent of `#:use-sources' 2011-07-05 07:03:26 -06:00
Eli Barzilay
a38f384a00 Finish converting scheme' -> racket'.
Everything compiles fine now even if the compatibility bindings are
gone.
2011-06-28 00:45:38 -04:00
Eli Barzilay
debd1f9f1e Recketizing much in `net/*', mass ".ss" -> ".rkt" conversion in .scrbl files.
(Some other minor things here and there.)
2011-06-20 04:27:14 -04:00
Matthew Flatt
fbbb30f7b0 try to clarify intent of #:contracts' in defform' 2011-05-30 08:58:11 -06:00
Kevin Tew
0c4d90b1db codeblock line numbers 2011-04-02 16:01:21 -06:00
Matthew Flatt
bbc5533938 Scribble: change the way `racketblock' etc. indent/inset works
- introduce 'code-inset style for nested blocks
 - use style instead of spaces for code indentation
 - sigplanconf adds vertical space around 'code-inset
 - more ...0 variants to compose better
2011-03-30 15:12:30 -06:00
Matthew Flatt
3fb4561a62 scribble/manual: document `this-obj' 2011-03-13 09:02:39 -06:00
Matthew Flatt
d704f9565b fix typo 2011-02-02 16:09:45 -07:00
Matthew Flatt
c8e3d45dae make `codeblock' work without a #lang line
but revise docs to clarify that a #lang line is really expected
 Closes PR 11385
2011-01-16 19:12:38 -07:00
Matthew Flatt
8f23d9dc1a fix reference hyphen and some abbreviations 2011-01-07 09:48:03 -07:00
Matthew Flatt
aa7c4b53d9 add `codeblock' to Scribble 2010-10-31 07:09:27 -06:00
Matthew Flatt
656321dbcb add optional #:key' argument to tech' and `techlink'
to specify the defined technical term separate from the link content
2010-08-03 12:48:03 -06:00
Matthew Flatt
c18603f767 add racketresultblock, etc. to Scribble 2010-05-31 13:55:16 -06:00
Matthew Flatt
ed1c74108f fix Scribble doc reference to element 2010-05-18 00:21:46 -06:00
Matthew Flatt
bb26115591 add 'filebox' Scribble function 2010-05-16 17:28:55 -06:00
Matthew Flatt
fb4af54436 rackety Scribble doc 2010-05-02 12:00:44 -06:00
Matthew Flatt
b61a99c433 add defidform/inline and use it to document on-draw 2010-04-28 06:41:43 -06:00
Matthew Flatt
616080c7c4 change 'define-struct' to bind the type name as a constructor, add an #:extra-constructor-name option, etc. 2010-04-25 12:10:36 -06:00
Matthew Flatt
c5ac9f23ec better compiler handling of unused local bindings where the RHS either doesn't obviously produce a single value or is discovered to be unused late in bytecode compilation; initial Scribble support for printing qq-style results
svn: r18737
2010-04-06 15:52:36 +00:00
Matthew Flatt
01d15eb9b6 add unsafe-fx->fl; avoid some gcc warnings
svn: r16221
2009-10-02 19:45:41 +00:00
Jay McCarthy
3432cf282f Adding more specific contracts
svn: r15709
2009-08-11 22:31:44 +00:00
Jay McCarthy
d8bc61ae41 Adding more specific contracts
svn: r15708
2009-08-11 22:10:47 +00:00
Matthew Flatt
970a796bc6 defmodulelang and schememodlink changes to split lang text and module path
svn: r15619
2009-07-29 13:15:50 +00:00
Matthew Flatt
229e2636de change scribble 'variant' to 'property'; add contracts in scribble/decode
svn: r15581
2009-07-27 03:55:43 +00:00
Matthew Flatt
bc9eef93f6 Scribble manual typos and up-to-date scribble/sigplan docs
svn: r15571
2009-07-26 02:52:37 +00:00
Matthew Flatt
345c17e85c major Scribble revision (v4.2.1.2)
svn: r15569
2009-07-25 20:25:33 +00:00
Matthew Flatt
bcfb69b21f add compound-paragraphs to Scribble, improve Latex rendering for unnested single-column tables
svn: r15378
2009-07-04 00:52:03 +00:00
Eli Barzilay
28efb47c90 better
svn: r15115
2009-06-08 07:48:24 +00:00