It would be wonderful to have an emacs mode for simpleDoc!!

[DanGrayson]

It would be wonderful to have an emacs mode for simpleDoc!!

David

David Eisenbud, Director,
Mathematical Sciences Research Institute
and Professor of Mathematics,
University of California, Berkeley

On Sun, Jun 7, 2020 at 4:42 PM Daniel R. Grayson [email protected]
wrote:

@DanGrayson commented on this pull request.

In M2/Macaulay2/packages/SimpleDoc/doc.txt
Macaulay2/M2#1234 (comment):

@@ -12,7 +29,7 @@ Node
Consequences
Item
The string {\tt s} is handled by parsing it the same way @ TO doc @ does,

• but expecting the least indented keyword to be {\bf Node}, which can occur

• but expecting the least indented keyword to be @ TO Node @, which can occur

What do you think about changing Node to doc? There are only about 20
packages that use it, so changing it wouldn't be difficult.

I see the following disadvantages:

• "doc" is not a word
• "doc" is not capitalized
• "doc" is already in use for something else in the package
• the word "Node" is descriptive: it introduces a documentation node
• the change would not be backward compatible.

Here's a change I would like to see instead, even though it's backward
compatible, if @mikestillman https://github.com/mikestillman approves:

• get rid of "doc" and "multidoc"
• attach the functionality of "multidoc" as the method for "document
  String", which is currently empty

It would also be cool to develop an emacs mode for SimpleDoc files. It
could take care of the indentation and helping us know which keywords are
valid at the current level of indentation.

—
You are receiving this because you are subscribed to this thread.
Reply to this email directly, view it on GitHub
Macaulay2/M2#1234 (comment), or
unsubscribe
https://github.com/notifications/unsubscribe-auth/AA6UWDILJCZZR4YCIB4LGK3RVQQW3ANCNFSM4NTCIMKQ
.

Originally posted by @eisenbud in Macaulay2/M2#1234 (comment)