Skip to content

Commit 9f41940

Browse files
Update InputTextFile and OutputTextFile documentation for compression
1 parent 11e5297 commit 9f41940

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

lib/streams.gd

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -626,7 +626,8 @@ DeclareOperation( "InputTextString", [ IsString ] );
626626
## <Description>
627627
## <C>InputTextFile( <A>filename</A> )</C> returns an input stream in the category
628628
## <Ref Filt="IsInputTextStream"/> that delivers the characters from the file
629-
## <A>filename</A>.
629+
## <A>filename</A>. If <A>filename</A> ends in <C>.gz</C> and the file is
630+
## a valid gzipped file, then the file will be transparently uncompressed.
630631
## </Description>
631632
## </ManSection>
632633
## <#/GAPDoc>
@@ -725,6 +726,8 @@ DeclareOperation( "OutputTextString", [ IsList, IsBool ] );
725726
## category <C>IsOutputTextFile</C> that writes received characters to the file
726727
## <A>filename</A>. If <A>append</A> is <K>false</K>, then the file is emptied first,
727728
## otherwise received characters are added at the end of the file.
729+
## If <A>filename</A> ends in <C>.gz</C> then the file will be
730+
## written with gzip compression.
728731
## <P/>
729732
## <Example><![CDATA[
730733
## gap> # use a temporary directory

0 commit comments

Comments
 (0)