From a7368d1b527a7d54ca7de75f08aad7f4735b279d Mon Sep 17 00:00:00 2001 From: Mike Gerwitz Date: Wed, 22 Mar 2017 12:16:03 -0400 Subject: [PATCH] doc/design.texi (Program): Add matinenance and mv notices --- doc/design.texi | 15 +++++++++++++++ doc/macros.texi | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/doc/design.texi b/doc/design.texi index 5839d26..7d197e3 100644 --- a/doc/design.texi +++ b/doc/design.texi @@ -244,6 +244,21 @@ Error state is managed by @node Program @section Program +@maintenance{ + The @code{Program} class was one of the first prototypes created, + and has evolved poorly with the rest of the system. + It is the base class for all compiled programs, + and it glues together too many other systems with a terrible + API and little to no encapsulation. + + With that said, it is one of the least touched classes (thus its + state); developers rarely have the need to touch @code{Program}.} + +@mvnotice{ + The core @code{Program} class that causes maintenance concerns needs + to be added to Liza. + It is currently mocked as necessary in test cases.} + @cindex Program The @dfn{Program} is a declarative representation of an entire system. diff --git a/doc/macros.texi b/doc/macros.texi index 388c874..be46533 100644 --- a/doc/macros.texi +++ b/doc/macros.texi @@ -110,7 +110,7 @@ @c needs to be moved into liza @macro mvnotice{text} @noticestart{mv} -All or part of this system needs to be moved into Liza.@footnote{ +@emph{All or part of this system needs to be moved into Liza.}@footnote{ \text\} @noticeend @end macro