Ben Greenman
c00340c5f0
doc: change input/output contracts for 'current-command-line-arguments'
...
The parameter accepts a vector of string & converts the input to a
vector of immutable strings.
2018-02-07 22:21:11 -05:00
Ben Greenman
24f4de4dea
doc: fix some contract combinators links
...
Fix some out-of-date argument names in the descriptions of contract
combinators.
E.g. 'get-late-neg-projection' => 'late-neg-proj'
2018-02-07 20:10:51 -05:00
Alexis King
02f6162283
Add splicing-parameterize to racket/splicing
2018-02-01 10:28:20 -08:00
Andrew M. Kent
7b61fa5f7a
docs: fix delimiter typo in for's scribblings
2018-01-31 15:05:10 -05:00
Matthew Flatt
f9d29242c4
doc correct ion hash-table printing
...
Hash tables with weakly held keys always print as
`#<hash>`.
2018-01-12 15:15:55 -07:00
Leif Andersen
16b8a4edc7
Correct the docs for surrogate's augment form.
2018-01-08 16:04:37 -05:00
Eric Dobson
f6bec77535
Filesystem doc wording improvements. ( #1923 )
2018-01-08 01:42:42 -05:00
Matthew Butterick
4481546481
Edit out another “performant”
2018-01-06 15:13:14 -07:00
Matthew Butterick
9ea7ae7d38
Edit out “performant”
2018-01-06 15:13:14 -07:00
Eric Dobson
452b2a6f92
Fix type in filesystem docs
2018-01-06 15:12:41 -07:00
shhyou
3d74bab8ff
Fix the document of struct-type-make-constructor
2018-01-02 14:27:18 -06:00
shhyou
a240bfe338
Update current-load(/used-compiled) documentation.
...
Reflect the default behavior of the load handler and
the compiled-load handler when the source file does
not exist.
2018-01-02 14:26:09 -06:00
Alexis King
868815c72e
Fix the vector-drop-right docs to clarify the indexing direction
2017-12-27 10:23:56 -08:00
Matthew Flatt
fe1d9ee517
document/test optional argument of impersonator propertry accessor
...
An impersonator-property accessor accepts a failure argument
in the same was as a structure-type--property accessor.
2017-12-22 19:07:36 -07:00
Matthew Flatt
5dec488ec4
add custodian-shut-down?
2017-12-18 15:37:04 -07:00
Matthew Flatt
f214bedf7d
reference: fix link to DrRacket docs
...
Closes #1914
2017-12-18 06:52:13 -07:00
Ryan Culpepper
ea0efd9e14
add docs for lazy-require-syntax
2017-12-15 21:19:12 +01:00
Matthew Flatt
5ad28e8942
fix unsafe-poller
result handling and improve docs
2017-12-12 12:07:41 -07:00
Matthew Flatt
fc77c91102
doc typo
2017-12-11 17:58:24 -07:00
Matthew Flatt
f16576fff3
doc repair
2017-12-08 17:47:14 -07:00
Matthew Flatt
1e1426a570
Revert "doc correction for will-execute
"
...
This reverts commit 52e7267273
.
The change was for `will-try-execute`. And while the change
is a good idea, `will-try-execute` doesn't acually accept
the extra argument.
2017-12-08 17:15:13 -07:00
dented42
167164b8a0
Fixed a typo ( #1907 )
...
Fixed a typo in the reference documentation for `impersonate-procedure*`.
2017-12-08 15:20:46 -05:00
Matthew Butterick
b538d03d5a
Remove bold
from inside title
of Reference
...
So that the formatting doesn’t propagate throughout the docs.
2017-11-21 10:08:13 -08:00
Sam Tobin-Hochstadt
ff5f5ff2af
Fix range for random-seed
.
...
Closes #1892 .
2017-11-16 12:52:34 -05:00
Matthew Flatt
ee19bf8c99
add missing history
note for check-duplicates
2017-11-09 06:23:47 -07:00
Huma Zafar
4e864a5387
Adds optional keyword argument to check-duplicates to determine returned value when no duplicate found.
2017-11-08 18:47:19 -06:00
Stephen De Gabrielle
3cb7044976
filesystem-change-evt? typo
...
changed
Returns #f if v is a filesystem change event, #f otherwise.
to
Returns #t if v is a filesystem change event, #f otherwise.
2017-11-06 16:25:37 -06:00
Ben Greenman
64a9791031
doc: index 'RED' and 'REL'
2017-11-04 22:41:10 -04:00
Spencer Florence
4f1ef42d07
replace { with [ to fix exn reference
2017-11-02 13:53:12 -05:00
Robby Findler
b9cd60010f
correct path examples
2017-10-31 16:12:46 -05:00
Matthew Flatt
c52bd91c54
add unsafe-struct*-cas!
2017-10-25 17:36:03 -06:00
Daniel Mendler
bc26d29bf8
add vector-cas! and unsafe-vector*-cas!
2017-10-25 17:36:03 -06:00
Andrew Kent
9e16d3f9c9
add #:result clause to for/fold forms
2017-10-18 07:15:15 -04:00
Alexis King
00d438cfbe
Make splicing-syntax-parameterize recur into module* without a mod-path
2017-10-15 15:53:59 -06:00
Matthew Flatt
1cc55f30fe
subprocess: support adding to an existing subprocess group
2017-10-12 12:37:21 -06:00
Matthew Flatt
9f5e9c8db3
fix documented contract for {absolute,relative,complete}-path?
...
They accept any string, instead of just path strings.
2017-10-12 12:37:20 -06:00
Matthew Butterick
43caae97b7
Doc typo
2017-10-04 21:14:12 -04:00
Daniel Feltey
ed5911e531
make contract-stronger?
return #f for impersonator contracts that don't implement stronger
2017-09-29 15:57:56 -05:00
Leif Andersen
e5a14c4f9d
Add make-serialize-info example.
2017-09-28 13:53:19 -04:00
Ben Greenman
56443e76a9
doc: remove extra '}'
2017-09-28 00:48:51 -04:00
Ben Greenman
f29d77d3d8
doc: swap takef / dropf codomain contracts
...
The codomain for `takef-right` didn't match `take-right`.
Same for `dropf-right`.
2017-09-25 16:35:39 -04:00
Ben Greenman
1933501658
doc: fix hash-union contracts
...
Changed to match `hash-set` and `hash-set!` contracts
- `hash-can-functional-set?` => `immutable?
- `hash-mutable?` => `(not/c immutable?)`
2017-09-25 16:35:23 -04:00
Ben Greenman
807ce8d495
typo: 'namesapce'
2017-09-18 15:14:52 -04:00
Michael Ballantyne
7c3ff9da18
Improve namespace-attach-module
example
...
The current example fails to illustrate the complete use, as the final evaluation of `apple` would succeed even without the `namespace-attach-module` call. This updated example demonstrates that `namespace-require` is still needed after the module is attached, and also shows how the behavior differs from `namespace-attach-module-declaration`.
2017-09-18 14:57:41 -04:00
Milo Turner
361442c197
require racket/contract/base in generic.scrbl to fix label links
2017-09-04 10:50:40 -05:00
Ben Greenman
b743544806
doc: example recursive-contract ( #1785 )
2017-08-28 16:15:51 -04:00
Sam Tobin-Hochstadt
3dd17c73ed
Clarify current-future. ( #1780 )
2017-08-23 16:58:52 -04:00
Matthew Flatt
52e7267273
doc correction for will-execute
2017-08-19 19:02:06 -06:00
Ben Greenman
3e2325acaf
doc: #lang racket does not reprovide 'racket/logging'
2017-08-19 00:53:42 -04:00
Matthew Flatt
d6fdabd691
fix doc typo
2017-08-18 09:27:23 -06:00
shhyou
e997bb96ea
Point make-meta-reader to the document of read
...
- Point read, read-syntax and make-meta-reader to
the documentation explaining the arguments of
read and read-syntax.
2017-08-15 07:12:40 -06:00
Matthew Flatt
59fc3758f0
thread-suspend-evt: doc correction
2017-08-10 18:33:49 -06:00
Matthew Flatt
f790084e11
call-in-nested-thread: add missing info in docs
2017-08-10 18:33:49 -06:00
Ryan Culpepper
5519a8ab45
example of unquoted-printing-string in make-constructor-style-printer
2017-08-04 12:24:13 -04:00
Matthew Flatt
cbfcc904ab
add unquted-printing strings
...
And unquoted-printing string contains a string to `display` in all
print modes. Although it could be implemented with a structure type
that has a printing function, `raise-arguments-error` further treats
unquoted-printing strings specially by not using the error value
conversion handler, so it reliably produces literal text in the error
message; that way, `raise-arguments-error` can be used to construct
more error messages.
2017-08-04 06:13:19 -06:00
Matthew Flatt
1ca8b6d533
bytes-utf-8-length: fix result contract in docs
2017-08-04 06:13:19 -06:00
Weng Shiwei
12e497e0e8
adding file extension ".scrbl" to fix redirection
...
adding file extension ".scrbl" to fix url redirect error. Otherwises, it triggers a redirection error.
This link is just before [section 8.7.1 in reference of contract](https://docs.racket-lang.org/reference/Building_New_Contract_Combinators.html )
This fix works and I guess it's correct.
I didn't compile the document project but I searched other `@other-doc` tags in project, the link in lib are all ending with `.scrbl`
The current generated url is:
https://download.racket-lang.org/docs/6.9/html/local-redirect/index.html?tag=%28part._%28.%27%28lib._contract-profile%2Fscribblings%2Fcontract-profile..rkt%29.%27._.%27top.%27%29%29&version=6.9
If changing `rkt` to `scrbl` in the url:
[https://download.racket-lang.org/docs/6.9/html/local-redirect/index.html?tag=%28part._%28.%27%28lib._contract-profile%2Fscribblings%2Fcontract-profile..scrbl%29.%27._.%27top.%27%29%29&version=6.9 ](https://download.racket-lang.org/docs/6.9/html/local-redirect/index.html?tag=%28part._%28.%27%28lib._contract-profile%2Fscribblings%2Fcontract-profile..scrbl%29.%27._.%27top.%27%29%29&version=6.9 )
The redirected result is correct.
2017-07-31 17:32:53 -06:00
Carlo Dapor
1e9a56215f
In English, "one" can be used both when counting (1, 2, 3, 4, 5, ...) as well as an atricle in front of a nouns (one tree, one bridge, ...). In German the two use cases are distinct. "One" as in counting is "eins, zwei, drei, vier, ...", but as an acticle it would be "ein" (for male or neutral nouns) or "eine" (for female nouns). Thus in the text the correct term would be "eins" in German.
...
For the French counting, "une" is not quite correct. It is the female form for "one" as an article. It is much more common to count "un", "deux", "troix", "quatre", "cinq", ....
2017-07-28 09:58:12 -06:00
Matthew Flatt
94b9b8f4dd
document integer->integer-bytes
and integer-bytes->integer
change
2017-07-28 09:51:15 -06:00
Ben Greenman
1f6b31aa3e
doc: remove unmatched ]
2017-07-23 19:32:26 -04:00
Matthew Flatt
d1fa65ac92
doc correction for chaperone-of?
2017-07-23 08:21:28 -06:00
Ben Greenman
37006520d3
doc: path cleaner examples
...
Add quick examples for:
- `cleanse-path`
- `simplify-path`
- `normalize-path`
2017-07-21 16:08:36 -05:00
Ben Greenman
c15fd5045a
doc: add grammar for 'recursive-contract' type option
2017-07-21 14:52:05 -05:00
Matthew Flatt
0f549823c4
call-with-immediate-continuation-mark: fix docs
...
Closes #1747
2017-07-18 06:42:53 -06:00
Leif Andersen
cca6db4ff0
Add links for examples to contracted functions.
...
is-a?/c -> is-a?
implementation?/c -> implementation?
subclass?/c -> subclass?
2017-07-11 12:30:45 -04:00
Vincent St-Amour
5f740ffcac
Fix typesetting of inpersonator-of docs.
2017-07-07 14:55:18 -05:00
Ben Greenman
5917f92ac1
typo: remove extra period in vectorof docs
2017-07-04 13:03:22 -04:00
Matthew Butterick
442c2fdfaf
Correct typo
...
`bust be an` → `must be a`
2017-07-02 22:58:33 -04:00
Matthew Flatt
ed8145e0d2
fix doc typo
2017-07-02 14:26:59 -06:00
Matthew Flatt
eb24c1e0b1
find-relative-path: correct contract in docs
...
Also, avoid a test on Windows that can't work there.
2017-06-29 13:26:24 -06:00
Matthew Flatt
7939e32a57
docs: fix {read,peek}-{byte,char}-or-special
argument order
2017-06-29 13:20:57 -06:00
Matthew Flatt
81f1c90ee0
small corrections reader docs
...
Fixes inaccuracies discovered when reimplementing
the reader in Racket.
2017-06-22 15:00:00 -06:00
Matthew Flatt
3c07250db4
fix printer for (unquote @d)
...
Avoid printing `(unquote @d)` or `(unsyntax @d)` as `,@d` or `#,@d`,
which would mean `(unquote-splicing @d)` or `(unsyntax-splicing @d)`
to the reader, by adding an extra space before the `@`.
2017-06-22 15:00:00 -06:00
Matthew Flatt
4bbe7a241d
doc clarification for parameterize-break
2017-06-22 12:59:02 -06:00
Matthew Flatt
0d2908f824
regexp docs: minor corrections
...
Fixes inaccuracies discovered when reimplementing
regexp matching in Racket.
2017-06-22 12:25:43 -06:00
Matthew Flatt
36e2155b91
tcp-addresses: fix docs to note that a UDP socket is accepted
2017-06-22 12:25:43 -06:00
Ben Greenman
a915433b02
doc: add tech link for box in 'immutable?' description
2017-06-21 01:47:01 -04:00
Matthew Flatt
d8fcbc7b56
remove incorrect claim about identifier-binding
...
It was true for the old macro system, but it isn't true now.
Closes #1485
2017-06-20 11:59:26 -06:00
Matthew Flatt
60e85fcaf3
rktio: document 'replace and 'replace/truncate changes
2017-06-19 06:45:18 -06:00
Ben Greenman
6d7f075ec5
typo: set 'subset?' functions take 2 arguments, no more
2017-05-30 17:47:53 -04:00
Matthew Flatt
bf83d1126d
add some unsafe operations as an alternative to FFI access
...
Accessing unsafe functionality through the FFI seemed like a good way
to avoid writing C code, but it made things more complicated instead
of easier, and it interacts badly with a more agressive shift away
from C (such as porting to Chez Scheme). So, add functions to the
primitive `#%unsafe` module, instead.
2017-05-26 16:26:06 -06:00
Georges Dupéron
5904cea99a
Small changes to the documentation
...
* Fixed typo in the docs for serialization (serializable-struct/version → serializable-struct/versions)
* Fixed typo in scribble documentation (head pattern → a-pattern)
* Made the order of the argument descriptions match the order of the arguments in the documentation for import and export
2017-05-12 16:01:29 -05:00
Matthew Flatt
f43234e1cb
add prop:authentic
and (struct .... #:authentic ....)
...
An authentic structure type is one whose instances cannot be
impersonated or chaperoned. The intended use of `prop:authentic` is to
annotate a library-private data structure where impersonators are
never needed internally for the data structure, and the declaration
lets the compiler produce less code and fewer branches by omitting
impersonator support.
2017-05-12 12:40:57 -06:00
Matthew Butterick
7908be8ce9
Fix spelling errors ( #1687 )
...
“cooresponds” → “corresponds” x2
2017-05-11 10:08:26 -04:00
Ben Greenman
11484b9d34
doc: explain blame object passed to late-neg
...
The blame object passed to a late-neg-proj function will be missing
one party. The missing party is sometimes the negative party and
sometimes the positive party.
2017-05-01 18:26:01 -04:00
Sam Caldwell
a666f1b0c1
typo
2017-05-01 16:34:26 -04:00
Vincent St-Amour
4ffd2fc1b8
Restore docs about impersonator-of? and immutable hash tables.
...
In the impersonate-hash docs, this time.
2017-04-30 13:44:49 -05:00
Vincent St-Amour
206ced8d47
Add examples for impersonator-of?.
2017-04-30 13:44:49 -05:00
Vincent St-Amour
d9b39eac1f
Add back desciption of impersonator-of?'s behavior on impersonator subparts.
2017-04-30 13:44:49 -05:00
Daniel Feltey
e29dba115b
New impersonator-of? docs
2017-04-30 13:44:49 -05:00
Matthew Flatt
bb2f1998f1
document binding structure of for/fold
...
The binding structure is not natural, but changing the binding rules
would risk breaking existing code.
Closes #1659
2017-04-29 11:08:42 -07:00
Vincent St-Amour
13443dec92
Add chaperone-vector*, unsafe-chaperone-vector, and property-only vector chaperones.
...
By analogy with the procedure chaperone equivalents.
2017-04-28 14:27:53 -05:00
Matthew Butterick
6e64da6880
Fix typos ( #1651 )
...
Fix typos
`sourve` → `source` x4
2017-04-27 09:16:22 -06:00
Matthew Flatt
608e6cc2a2
add tests for racket/port
...
Also, fix some doc typos.
2017-04-26 17:16:59 -06:00
Matthew Flatt
d469265a6e
Makefile: support both cross-platform and non-cross installers
...
In non-cross mode, `-C` needs to go after `-G` and `-X` when setting
up a "bundle" directory to turn into an installer, because that mode
needs to use foreign libraries (such as SQLite) at build time, and it
can use the instances that are being set up for the installer.
Meanwhile, improve the advice for setting `PLAIN_RACKET` to use `-C`
for a cross-platform build mode, even though things tend to work
anyway without it.
2017-04-26 15:59:04 -06:00
Philip McGrath
e9cd1e5595
Corrected Racket Reference for get/build-late-neg-projection
...
and `get/build-val-first-projection`.
Both had incorrectly shown that the returned function took
a `contract?` as an extra first argument.
2017-04-25 14:57:50 -05:00
Matthew Flatt
c917434a86
improve cross-platform support
...
Detangle the target and host DLL and library directories by
making `get-lib-search-dirs` and `get-dll-dir` report the
host system's directories, and add `get-cross-lib-search-dirs`
and `get-cross-dll-dir`.
A new `-C`/`--cross` flag causes `racket` to save a host config and
collection directory and make them available via `(find-system-path
'host-{config,collects}-dir)`, while plus `(system-type 'cross)`
reports whether `-C` mode is in effect. Besides making the host paths
available, this change allows a same-platform build to run in
corss-platform mode.
The immediate problem to solve was the creation of Windows installers
on Windows, where recent changes to support 'gui-bin-dir configuration
need a clear distinction between the host Racket and the target Racket
being built, even if they're the same platform. (The "GRacket.exe"
executable didn't work, for example.)
The changes in this commit are more than needed for the immediate
problem, but they naturally build on the necessary `-C` flag, and they
support cross-platform package setup where native libraries are needed
during setup.
2017-04-25 08:31:26 -06:00
Scott Moore
54bd21e65a
Discuss security considerations of racket/sandbox in Reference
2017-04-20 16:23:00 -05:00
Vincent St-Amour
c652afa894
Document surprising behavior of in-range
with floats and zero.
2017-04-17 20:23:28 -05:00
Leif Andersen
922b5f06e9
Make log also accept a base. ( #1667 )
...
Make `log` in `racket/base` optionally accept a second argument.
The second argument is the log `base`. The docs also recommend
`fllogb` when precision is important.
* Error message when base is 1
* Added docs.
* Add tests.
2017-04-15 10:40:41 -04:00