Commit Graph

27 Commits

Author SHA1 Message Date
Matthew Flatt
b3f7015cba allow content (not just a string) for #:kind in defthing, etc.
Although commit 5415cca336 just made run-time checking consistent with
the documentation, the implementation turned out to allow content
before, and some existing documents relied on that. Changes the
documentation and contract to allow content, instead.
2020-10-07 07:36:14 -06:00
sorawee
cbeee2d388
Add racketoptionalfont
Scribble used to support a custom style for optional brackets.
In particular, the optional brackets will be given the `'paren-shape`
of value `#\?`[1], and the CSS class `opt-color` will be tagged
to these brackets.

Later, Scribble supports the curry notation. Its implementation
no longer uses `'paren-shape` to indicate optional brackets.
Unfortunately, it accidentally dropped the `opt-color` tagging[2].

This PR restores the original behavior by tagging the class
`opt-color` to optional brackets. It also adds `racketoptionalfont`
so that Scribble users can typeset optional brackets.
Lastly, it cleans up the code that supports the `'paren-shape` of value
`#\?`, since it is effectively a deadcode.

Note that this PR does _not_ change any CSS styling, so there's no
visible change. It would make CSS styling customization easier, however.

[1]: 9b7993ea02 (diff-017add06555fc85fa3ae5f27a3eb52cbR253)
[2]: https://github.com/racket/scribble/commit/95ecb101d1cc61d212c4d520#diff-017add06555fc85fa3ae5f27a3eb52cbR879
2020-08-21 09:01:57 -06:00
sorawee
7f5a2b2648
disallow bogus mode arguments and fix related bugs
Fix #131:

- Raise a syntax error when bogus mode arguments are given.
- Fix a bug where `extend-final` and `augment-final` are not recognized
- Document the `public` mode which was already supported but not
  documented.
- Clarify the default mode when `maybe-mode` is not given.
2020-06-19 06:29:51 -06:00
Sorawee Porncharoenwase
fd9b85aa10 It links to the reference, not the guide. 2020-04-21 22:03:10 -04:00
Alexis King
ed02550d1a Fix the contracts on exec/commandline to match their behavior 2020-01-02 13:20:23 -06:00
Matthew Flatt
431bb95c7b improve markdown renderer, including support for section links 2019-10-16 05:36:48 -06:00
Leif Andersen
0905c3d6a3 Line 1 got messed up during the commit, reverting. 2019-04-10 13:17:51 -04:00
Leif Andersen
51c1c2ed47 Minor typo:
each expression is are duplicated -> each expression is duplicated
2019-04-10 13:14:07 -04:00
Ben Greenman
ac37653988 doc: explain typeset-code's #:block argument 2019-02-24 18:20:11 -05:00
Paulo Matos
3349b13825 Add block? contract to typeset-code (#196)
I think something should be said about what `block?` does but I am not comfortable enough with the scribble code to write it down.
2019-02-24 17:55:03 -05:00
Ben Greenman
1a5f2a44bd
add optional #:note to 'bib-entry' (#176)
Add an optional argument to bib-entry to typeset a comment directly
after a citation --- with no punctuation between the end of the citation
and start of the comment.

Example: making an annotated bibliography, with an element that appears just
below each citation
2018-09-12 22:03:51 -04:00
Ben Greenman
858743b679 typo: 'regonized' 2018-09-02 20:16:52 -04:00
Ben Greenman
e07fac631c typo: 'line-number-sep' => 'line-number-sep-expr' 2018-02-11 20:24:04 -05:00
Matthew Flatt
18e467ef9e disable _ prefix handling in racketmodname and other places
In places where module names are typeset, such as `racketmodname`,
there's no way to disable the special treatment of `_` as an
identifier prefix as in `racket`. Even using
`make-element-id-transformer` doesn't work, because the module-name
datum is explcitly disconnected from binding withing `racketmodname`.
2017-04-14 06:52:16 -06:00
Robby Findler
725f2bc9ed adjust for new location of 'blame object' @deftech{} 2017-04-12 21:48:08 -05:00
Leif Andersen
6b261eb6f8 Add an example for defstruct* 2016-11-14 15:58:56 -05:00
Asumu Takikawa
f4f3354466 Add doc examples for history form 2016-07-21 13:50:01 -04:00
Ben Greenman
2b972d9cc9 doc: add missing index-desc field descriptions 2016-07-08 22:28:53 -04:00
Ben Greenman
5505a5557a Add language-index-desc and reader-index-desc
Subtypes of module-index-desc.
Used to tell if a module implements a #lang or a #reader module.
2016-07-08 17:56:35 -04:00
Matthew Flatt
e92229f481 doc: explain indentation and workaround for racketresultblock 2016-03-07 19:21:39 -07:00
Matthew Flatt
bbbd68b3c2 declare-exporting: allow escaped module-path expressions 2015-12-30 06:54:51 -06:00
Matthew Flatt
296e55d0e0 correct docs on code:contract
Unfortunately, `scribble/manual` and `pict/code` differ on how they
color `code:contract` content.
2015-10-02 15:36:12 -06:00
Matthew Flatt
26eff4c03a fix racketblock docs on code:comment and code:contract 2015-10-02 15:24:08 -06:00
William J. Bowman
ea01ae2f68 Added example of @tech with #:doc
I never remember how to use this.
2015-09-17 11:14:09 -05:00
Robby Findler
c84c1cf6cc document typeset-code
also adjust contract on context-expr to admit that #f is allowed
2015-05-11 08:04:40 -05:00
Matthew Flatt
4a52d3c57c racketblock: add "#i" to an inexact number to match source span
This heuristic could go slightly wrong, for example causing "10.000"
to render as "#i10.0" instead of "10.0", but it won't affect cases
where the output already matched the input.
2015-02-21 14:12:38 -07:00
Sam Tobin-Hochstadt
a316fc12c0 Remove extra directories. 2014-12-02 00:54:52 -05:00