Skip to content

Commit

Permalink
Document that InputTextFile should not be used for binary files
Browse files Browse the repository at this point in the history
  • Loading branch information
ChrisJefferson authored and fingolfin committed Mar 25, 2019
1 parent 3bee8d5 commit 6424be9
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions lib/streams.gd
Original file line number Diff line number Diff line change
Expand Up @@ -629,6 +629,11 @@ DeclareOperation( "InputTextString", [ IsString ] );
## <Ref Filt="IsInputTextStream"/> that delivers the characters from the file
## <A>filename</A>. If <A>filename</A> ends in <C>.gz</C> and the file is
## a valid gzipped file, then the file will be transparently uncompressed.
## <P/>
## <C>InputTextFile</C> is designed for use with text files and automatically
## handles windows-style line endings. This means it should <E>not</E> be used for
## binary data. The <Ref BookName="IO" Oper="IO_File" /> function from the <Package>IO</Package>
## package should be used to access binary data.
## </Description>
## </ManSection>
## <#/GAPDoc>
Expand Down

0 comments on commit 6424be9

Please sign in to comment.