steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

sequences: fix docs to use "dst" as a convention.

db4
John Benediktsson 2012-09-19 15:53:37 -07:00
parent 19b6ae71d5
commit c1850f416a
3 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
core/io/streams/sequence/sequence.factor
View File

@ -17,7 +17,7 @@ SLOT: i
: (sequence-read-length) ( n buf stream -- buf count ) : (sequence-read-length) ( n buf stream -- buf count )
[ underlying>> length ] [ i>> ] bi - rot min ; inline [ underlying>> length ] [ i>> ] bi - rot min ; inline
: <sequence-copy> ( dest n i src -- n copy ) : <sequence-copy> ( dst n i src -- n copy )
[ 0 ] 3curry dip <copy> ; inline [ 0 ] 3curry dip <copy> ; inline
: (sequence-read-unsafe) ( n buf stream -- count ) : (sequence-read-unsafe) ( n buf stream -- count )

16
core/sequences/sequences-docs.factor
View File

@ -740,16 +740,16 @@ HELP: <repetition>
{ $example "USING: prettyprint sequences ;" "10 \"X\" <repetition> concat ." "\"XXXXXXXXXX\"" } { $example "USING: prettyprint sequences ;" "10 \"X\" <repetition> concat ." "\"XXXXXXXXXX\"" }
} ; } ;
HELP: copy HELP: copy
{ $values { "src" sequence } { "i" "an index in " { $snippet "dest" } } { "dst" "a mutable sequence" } } { $values { "src" sequence } { "i" "an index in " { $snippet "dst" } } { "dst" "a mutable sequence" } }
{ $description "Copies all elements of " { $snippet "src" } " to " { $snippet "dest" } ", with destination indices starting from " { $snippet "i" } ". Grows " { $snippet "to" } " first if necessary." } { $description "Copies all elements of " { $snippet "src" } " to " { $snippet "dst" } ", with destination indices starting from " { $snippet "i" } ". Grows " { $snippet "dst" } " first if necessary." }
{ $side-effects "dest" } { $side-effects "dst" }
{ $errors "An error is thrown if " { $snippet "to" } " is not resizable, and not large enough to hold the copied elements." } ; { $errors "An error is thrown if " { $snippet "dst" } " is not resizable, and not large enough to hold the copied elements." } ;
HELP: push-all HELP: push-all
{ $values { "src" sequence } { "dest" "a resizable mutable sequence" } } { $values { "src" sequence } { "dst" "a resizable mutable sequence" } }
{ $description "Appends " { $snippet "src" } " to the end of " { $snippet "dest" } "." } { $description "Appends " { $snippet "src" } " to the end of " { $snippet "dst" } "." }
{ $side-effects "dest" } { $side-effects "dst" }
{ $errors "Throws an error if " { $snippet "src" } " contains elements not permitted in " { $snippet "dest" } "." } ; { $errors "Throws an error if " { $snippet "src" } " contains elements not permitted in " { $snippet "dst" } "." } ;
HELP: append HELP: append
{ $values { "seq1" sequence } { "seq2" sequence } { "newseq" sequence } } { $values { "seq1" sequence } { "seq2" sequence } { "newseq" sequence } }

2
core/sequences/sequences.factor
View File

@ -329,7 +329,7 @@ M: sequence clone-like
M: immutable-sequence clone-like like ; inline M: immutable-sequence clone-like like ; inline
: push-all ( src dest -- ) [ length ] [ copy ] bi ; inline : push-all ( src dst -- ) [ length ] [ copy ] bi ; inline
<PRIVATE <PRIVATE