Skip to content

Commit 840dc17

Browse files
committed
Justin's feedback
1 parent 3d986e9 commit 840dc17

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

scribblings/fmt.scrbl

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222

2323
This package provides a tool @exec{raco fmt} to reformat Racket code.
2424

25-
The package uses @racketmodname[pretty-expressive], a very expressive pretty printer library, to compute the most optimal layout of the output code, and uses @racketmodname[syntax-color/module-lexer #:indirect] to lex the input program.
25+
The package uses @racketmodname[syntax-color/module-lexer #:indirect] to lex the input program, and uses @racketmodname[pretty-expressive], an expressive pretty printer library, to compute an optimal layout of the output code.
2626

2727
The interface to allow users to extend formatting style is extremely unstable and is still a work in progress. For now, the only thing that is stable is the command @exec{raco fmt}.
2828

@@ -44,16 +44,15 @@ The @exec{raco fmt} command accepts the following flags:
4444
@item{@DFlag{max-blank-lines} @nonterm{n} --- set the maximum consecutive blank lines limit
4545
to @nonterm{n}, which must be either a natural number or @racket[+inf.0].
4646
The default value is @racket[1].}
47-
@item{@DFlag{indent} @nonterm{n} --- set the indentation level for subsequent lines to @nonterm{n},
48-
which must be a natural number.
47+
@item{@DFlag{indent} @nonterm{n} --- set the indentation level in spaces to @nonterm{n} for subsequent lines.
4948
The default value is @racket[0].}
5049
@item{@Flag{i} --- modify the input files in-place instead of outputting to standard output.
51-
This flag has no effect if @exec{raco fmt} accepts the input from the standard input.}
50+
This flag has no effect if @exec{raco fmt} accepts the input from standard input.}
5251
]
5352

5453
@section{Examples}
5554

56-
Given the file @filepath{example.rkt} shown on the left, running @exec{raco fmt --width 40 example.rkt} would output the program on the right:
55+
Given the file @filepath{example.rkt} shown on the left, running @exec{raco fmt --width 40 example.rkt} outputs the program on the right:
5756

5857
@compare[
5958
@external-file["examples/example.rkt" #:name "example.rkt"]
@@ -133,17 +132,17 @@ which means the @tech{formatter map} wants to let other fallback
133132

134133
@defparam[current-width width (or/c +inf.0 natural-number/c)
135134
#:value 102]{
136-
See @secref["Running_raco_fmt"] for details.
135+
Parameter for the page width limit. See @secref["Running_raco_fmt"] for details.
137136
}
138137

139138
@defparam[current-max-blank-lines max-blank-lines (or/c +inf.0 natural-number/c)
140139
#:value 1]{
141-
See @secref["Running_raco_fmt"] for details.
140+
Parameter for the maximum number of blank lines. See @secref["Running_raco_fmt"] for details.
142141
}
143142

144143
@defparam[current-indent indent natural-number/c
145144
#:value 0]{
146-
See @secref["Running_raco_fmt"] for details.
145+
Parameter for the initial indentation level. See @secref["Running_raco_fmt"] for details.
147146
}
148147

149148
@section{Related work}

0 commit comments

Comments
 (0)