Macaulay2 » Documentation
Packages » Macaulay2Doc :: edit
next | previous | forward | backward | up | index | toc

edit -- edit source code

Description

Synopsis

  • Usage:
    edit f
  • Inputs:
  • Outputs:
    • a net, the editor is started up, pointing at the source code of the function or commandf

Synopsis

  • Usage:
    edit(f,X)
  • Inputs:
  • Outputs:
    • a net, the editor is started up, pointing at the source code of method for applying f to an argument of type X

Synopsis

  • Usage:
    edit(f,X,Y)
  • Inputs:
  • Outputs:
    • a net, the editor is started up, pointing at the source code of method for applying f to arguments of type X and Y

Synopsis

  • Usage:
    edit(f,X,Y,Z)
  • Inputs:
  • Outputs:
    • a net, the editor is started up, pointing at the source code of method for applying f to arguments of type X, Y, and Z

Synopsis

  • Usage:
    edit(f,X,Y,Z,T)
  • Inputs:
  • Outputs:
    • a net, the editor is started up, pointing at the source code of method for applying f to arguments of type X, Y, and Z, and T

The name of the user's preferred editor is take from the environment variable EDITOR. If X is running and the editor is not emacs, then the editor is started in a new xterm window.

For an interactive example, try edit(dim,Module).

The value returned is the exit code returned by the editor, as with run, usually zero.

For the programmer

The object edit is a command.