suzanne.soy/racket
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

adjust docs & history note for println and writeln

Browse Source 
When adding a new function or form, use

 @history[#:added "<version>"]

at the end of the documentation for the added function or formœ.
This commit is contained in:
Matthew Flatt 2015-02-12 09:18:37 -07:00
parent d3b018b7cb
commit 8c545ae05a
1 changed files with 11 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
pkgs/racket-doc/scribblings/reference/write.scrbl
View File

@ -68,7 +68,10 @@ any way.}
@defproc[(writeln [datum any/c] [out output-port? (current-output-port)]) @defproc[(writeln [datum any/c] [out output-port? (current-output-port)])
void?]{ void?]{
The same as @racket[(write datum out)] followed by @racket[(newline out)].} The same as @racket[(write datum out)] followed by @racket[(newline out)].
@history[#:added "6.1.1.8"]}
@defproc[(displayln [datum any/c] [out output-port? (current-output-port)]) @defproc[(displayln [datum any/c] [out output-port? (current-output-port)])
void?]{ void?]{
@ -76,6 +79,7 @@ The same as @racket[(write datum out)] followed by @racket[(newline out)].}
The same as @racket[(display datum out)] followed by @racket[(newline out)], The same as @racket[(display datum out)] followed by @racket[(newline out)],
which is similar to @tt{println} in Pascal or Java.} which is similar to @tt{println} in Pascal or Java.}
@defproc[(println [datum any/c] [out output-port? (current-output-port)] @defproc[(println [datum any/c] [out output-port? (current-output-port)]
[quote-depth (or/c 0 1) 0]) [quote-depth (or/c 0 1) 0])
void?]{ void?]{
@ -83,11 +87,13 @@ which is similar to @tt{println} in Pascal or Java.}
The same as @racket[(print datum out quote-depth)] followed by The same as @racket[(print datum out quote-depth)] followed by
@racket[(newline out)]. @racket[(newline out)].
This is not equivalent to @tt{println} in other languages because, by default, The @racket[println] function is not equivalent to @tt{println} in
it uses the printing conventions of @racket[write]. For a closer analog, use other languages, because @racket[println] uses printing conventions
@racket[displayln] instead.} that are closer to @racket[write] than to @racket[display]. For a closer
analog to @tt{println} in other languages, use @racket[displayln].
@history[#:added "6.1.1.8"]}
@history[#:changed "6.1.1.8" @elem{Added @racket[writeln] and @racket[displayln].}]
@defproc[(fprintf [out output-port?] [form string?] [v any/c] ...) void?]{ @defproc[(fprintf [out output-port?] [form string?] [v any/c] ...) void?]{