Skip to content

Use temporary files in manual examples #953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
james-d-mitchell merged 1 commit into from
Oct 8, 2026
Merged

Use temporary files in manual examples #953

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions doc/display.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,8 @@ node [shape=circle]
4 -> 2[color=pink]
4 -> 3[color=purple]
}
gap> FileString("k4.dot", DotDigraph(D));
gap> filename := Filename(DirectoryTemporary(), "k4.dot");;
gap> FileString(filename, DotDigraph(D));
133
gap> D := Digraph([[2, 3], [1, 3], [1]]);
<immutable digraph with 3 vertices, 5 edges>
Expand All @@ -272,7 +273,8 @@ node [shape=circle]
2 -> 3[color=pink]
3 -> 1[color=yellow]
}
gap> FileString("digraph.dot", DotDigraph(D));
gap> filename := Filename(DirectoryTemporary(), "digraph.dot");;
gap> FileString(filename, DotDigraph(D));
82]]></Example>
</Description>
</ManSection>
Expand Down Expand Up @@ -407,7 +409,8 @@ gap> poset := Digraph([[1, 4], [2], [2, 3, 4], [4]]);
<immutable digraph with 4 vertices, 7 edges>
gap> IsPartialOrderDigraph(poset);
true
gap> FileString("poset.dot", DotPartialOrderDigraph(poset));
gap> filename := Filename(DirectoryTemporary(), "poset.dot");;
gap> FileString(filename, DotPartialOrderDigraph(poset));
70]]></Example>
</Description>
</ManSection>
Expand Down Expand Up @@ -450,7 +453,8 @@ gap> preset := Digraph([[1, 2, 4, 5], [1, 2, 4, 5], [3, 4], [4],
<immutable digraph with 5 vertices, 15 edges>
gap> IsPreorderDigraph(preset);
true
gap> FileString("preset.dot", DotPreorderDigraph(preset));
gap> filename := Filename(DirectoryTemporary(), "preset.dot");;
gap> FileString(filename, DotPreorderDigraph(preset));
179]]></Example>
</Description>
</ManSection>
Expand All @@ -477,7 +481,8 @@ gap> FileString("preset.dot", DotPreorderDigraph(preset));
<Example><![CDATA[
gap> digraph := Digraph([[2, 3], [2], [1, 3]]);
<immutable digraph with 3 vertices, 5 edges>
gap> FileString("my_digraph.dot", DotHighlightedDigraph(digraph,
gap> filename := Filename(DirectoryTemporary(), "my_digraph.dot");;
gap> FileString(filename, DotHighlightedDigraph(digraph,
> [1, 2], "red", "black"));
264]]></Example>
</Description>
Expand Down
11 changes: 5 additions & 6 deletions doc/io.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ false
To see what file types are available, see <Ref Func="WriteDigraphs"/>.

<Example><![CDATA[
gap> filename := Concatenation(DIGRAPHS_Dir(), "/tst/out/man.d6.gz");;
gap> filename := Filename(DirectoryTemporary(), "man.d6.gz");;
gap> file := DigraphFile(filename, "w");;
gap> for i in [1 .. 10] do
> WriteDigraphs(file, Digraph([[1, 3], [2], [1, 2]]));
Expand Down Expand Up @@ -225,7 +225,7 @@ gap> for x in iter do od;
</List>

<Example><![CDATA[
gap> filename := Concatenation(DIGRAPHS_Dir(), "/tst/out/man.d6.gz");;
gap> filename := Filename(DirectoryTemporary(), "man.d6.gz");;
gap> file := DigraphFile(filename, "w");;
gap> for i in [1 .. 10] do
> WriteDigraphs(file, Digraph([[1, 3], [2], [1, 2]]));
Expand Down Expand Up @@ -563,7 +563,7 @@ gap> grs[3] := Digraph([
> [3, 4, 5, 6, 7, 8, 9, 10], [1, 3, 5, 7, 8, 9], [1, 2, 5],
> [1, 2, 4, 6, 7, 8]]);
<immutable digraph with 10 vertices, 51 edges>
gap> filename := Concatenation(DIGRAPHS_Dir(), "/tst/out/man.d6.gz");;
gap> filename := Filename(DirectoryTemporary(), "man.d6.gz");;
gap> WriteDigraphs(filename, grs, "w");
IO_OK
gap> ReadDigraphs(filename);
Expand Down Expand Up @@ -708,7 +708,7 @@ gap> DigraphFromPlainTextString(last);
<Example><![CDATA[
gap> gr := Digraph([[1, 2, 3], [1, 1], [2]]);
<immutable multidigraph with 3 vertices, 6 edges>
gap> filename := Concatenation(DIGRAPHS_Dir(), "/tst/out/plain.txt");;
gap> filename := Filename(DirectoryTemporary(), "plain.txt");;
gap> WritePlainTextDigraph(filename, gr, ",", -1);
gap> ReadPlainTextDigraph(filename, ",", 1, ['/', '%']);
<immutable multidigraph with 3 vertices, 6 edges>
Expand Down Expand Up @@ -783,8 +783,7 @@ gap> ReadPlainTextDigraph(filename, ",", 1, ['/', '%']);
<Example><![CDATA[
gap> gr := Digraph([[2], [1, 3, 4], [2, 4], [2, 3]]);
<immutable digraph with 4 vertices, 8 edges>
gap> filename := Concatenation(DIGRAPHS_Dir(),
> "/tst/out/dimacs.dimacs");;
gap> filename := Filename(DirectoryTemporary(), "dimacs.dimacs");;
gap> WriteDIMACSDigraph(filename, gr);;
gap> ReadDIMACSDigraph(filename);
<immutable digraph with 4 vertices, 8 edges>]]></Example>
Expand Down
Loading