doc: change 'syntax->string' doc to match implementation (#2351)
The implementation requires a more specific input than the documentation suggests.
This commit is contained in:
parent
7fa31684e9
commit
982942b258
|
@ -1,13 +1,14 @@
|
||||||
#lang scribble/doc
|
#lang scribble/doc
|
||||||
@(require "common.rkt"
|
@(require "common.rkt"
|
||||||
(for-label syntax/stx
|
(for-label racket/contract
|
||||||
|
syntax/stx
|
||||||
syntax/to-string))
|
syntax/to-string))
|
||||||
|
|
||||||
@title[#:tag "to-string"]{Rendering Syntax Objects with Formatting}
|
@title[#:tag "to-string"]{Rendering Syntax Objects with Formatting}
|
||||||
|
|
||||||
@defmodule[syntax/to-string]
|
@defmodule[syntax/to-string]
|
||||||
|
|
||||||
@defproc[(syntax->string [stx-list stx-list?]) string?]{
|
@defproc[(syntax->string [stx-list (and/c syntax? stx-list?)]) string?]{
|
||||||
|
|
||||||
Builds a string with newlines and indenting according to the source
|
Builds a string with newlines and indenting according to the source
|
||||||
locations in @racket[stx-list]; the outer pair of parens are not
|
locations in @racket[stx-list]; the outer pair of parens are not
|
||||||
|
|
Loading…
Reference in New Issue
Block a user