add a note to the documentation of "beginDocumentation"

Macaulay2 · Mar 25, 2013 · 3c46824 · 3c46824
1 parent eab570d
commit 3c46824
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/M2/Macaulay2/packages/Macaulay2Doc/doc_packages.m2 b/M2/Macaulay2/packages/Macaulay2Doc/doc_packages.m2
@@ -181,6 +181,10 @@ document {
 	  be loaded separately, Macaulay2 examples in the documentation can
 	  be run, and the whole documentation can be stored in a database."},
      PARA { "For an example, see ", TO "an example of a package" },
+     PARA {
+	  "To write documentation without using the function ", TT "beginDocumentation", ", which is just
+	  an optimization, use ", TO "needsPackage", " to load the packages ", TT "SimpleDoc", " and ", TT "Text", "."
+	  },
      SeeAlso => { installPackage, check, "writing documentation" }
      }
 document {