Skip to content

Commit 88e8e52

Browse files
authored
Remove more deprecated stuff (#289)
1 parent be9f616 commit 88e8e52

File tree

3 files changed

+10
-40
lines changed

3 files changed

+10
-40
lines changed

CHANGES.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,15 @@
11
This file describes changes in the AutoDoc package.
22

33
2025.MM.DD
4-
- Remove `scaffold.gapdoc_latex_options` -- it was deprecated and
5-
replaced by `gapdoc.LaTeXOptions` in 2019
6-
- Remove `maketest`, it was deprecated and superseded by
7-
`extract_examples` in 2019
4+
- Remove a bunch of features that were deprecated since 2019:
5+
- `AutoDoc` option `scaffold.gapdoc_latex_options` has been
6+
replaced by `gapdoc.LaTeXOptions`
7+
- `AutoDoc` option `maketest` has been superseded by `extract_examples`
8+
- Various AutoDoc commands were removed (see the manual for replacements)
9+
- `@EndSection`, `@EndSubsection`
10+
- `@AutoDoc`, `@BeginAutoDoc`, `@EndAutoDoc`
11+
- `@System`, `@BeginSystem`, `@EndSystem`, `@InsertSystem`
12+
- `@AutoDocPlainText`, `@BeginAutoDocPlainText`, `@EndAutoDocPlainText`
813

914
2025.05.09
1015
- Add `InfoAutoDoc` info class for messages

doc/Comments.xml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -742,8 +742,7 @@ can be important.</E>
742742
<Section Label="Deprecated">
743743
<Heading>Deprecated commands</Heading>
744744

745-
The following commands used to be supported, but should not generally be used anymore.
746-
They will be removed in a future version of &AutoDoc;.
745+
The following commands used to be supported, but are not anymore.
747746

748747
<List>
749748
<Mark><C>@EndSection</C></Mark>

gap/Parser.gi

Lines changed: 0 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -522,13 +522,6 @@ InstallGlobalFunction( AutoDoc_Parser_ReadFiles,
522522
Reset();
523523
rest_of_file_skipped := true;
524524
end,
525-
@BeginAutoDoc := deprecated("@BeginAutoDoc", function()
526-
autodoc_read_line := fail;
527-
end),
528-
@AutoDoc := ~.@BeginAutoDoc,
529-
@EndAutoDoc := deprecated("@EndAutoDoc", function()
530-
autodoc_read_line := false;
531-
end),
532525

533526
@Chapter := function()
534527
local scope_chapter;
@@ -581,14 +574,6 @@ InstallGlobalFunction( AutoDoc_Parser_ReadFiles,
581574
scope_section := SectionInTree( tree, chapter_info[ 1 ], chapter_info[ 2 ] );
582575
scope_section!.title_string := current_command[ 2 ];
583576
end,
584-
@EndSection := deprecated("@EndSection", function()
585-
if not IsBound( chapter_info[ 2 ] ) then
586-
ErrorWithPos( "found @EndSection with no active section" );
587-
fi;
588-
Unbind( chapter_info[ 2 ] );
589-
Unbind( chapter_info[ 3 ] );
590-
current_item := ChapterInTree( tree, chapter_info[ 1 ] );
591-
end),
592577

593578
@Subsection := function()
594579
local scope_subsection;
@@ -616,13 +601,6 @@ InstallGlobalFunction( AutoDoc_Parser_ReadFiles,
616601
scope_subsection := SubsectionInTree( tree, chapter_info[ 1 ], chapter_info[ 2 ], chapter_info[ 3 ] );
617602
scope_subsection!.title_string := current_command[ 2 ];
618603
end,
619-
@EndSubsection := deprecated("@EndSubsection", function()
620-
if not IsBound( chapter_info[ 3 ] ) then
621-
ErrorWithPos( "found @EndSubsection with no active subsection" );
622-
fi;
623-
Unbind( chapter_info[ 3 ] );
624-
current_item := SectionInTree( tree, chapter_info[ 1 ], chapter_info[ 2 ] );
625-
end),
626604

627605
@BeginGroup := function()
628606
local grp;
@@ -731,11 +709,6 @@ InstallGlobalFunction( AutoDoc_Parser_ReadFiles,
731709
fi;
732710
end,
733711

734-
@InsertSystem := deprecated("@InsertSystem", ~.@InsertChunk),
735-
@System := deprecated("@System", ~.@BeginChunk),
736-
@BeginSystem := ~.@System,
737-
@EndSystem := deprecated("@EndSystem", ~.@EndChunk),
738-
739712
@BeginCode := function()
740713
local label_name, tmp_system;
741714
label_name := ReplacedString( current_command[ 2 ], " ", "_" );
@@ -811,13 +784,6 @@ InstallGlobalFunction( AutoDoc_Parser_ReadFiles,
811784
NormalizeWhitespace( current_command[ 2 ] );
812785
Add( tree!.worksheet_dependencies, SplitString( current_command[ 2 ], " " ) );
813786
end,
814-
@BeginAutoDocPlainText := deprecated("@BeginAutoDocPlainText", function()
815-
plain_text_mode := true;
816-
end),
817-
@AutoDocPlainText := ~.@BeginAutoDocPlainText,
818-
@EndAutoDocPlainText := deprecated("@EndAutoDocPlainText", function()
819-
plain_text_mode := false;
820-
end),
821787
@ExampleSession := function()
822788
local example_node;
823789
example_node := read_session_example( true, plain_text_mode );

0 commit comments

Comments
 (0)