simon/fedit
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Some modification of markdown to improve formatting.

Browse source
This commit is contained in:
Simon Brooke 2013-09-20 11:44:11 +01:00
parent 7aff7b82dc
commit 04619ed02b
1 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -6,7 +6,7 @@ An in-core editor for Clojure data structures and, particularly, functions.
Preliminary, incomplete, alpha quality code. This implements a structure editor in a terminal, Preliminary, incomplete, alpha quality code. This implements a structure editor in a terminal,
not a display editor in the tradition of InterLisp's DEdit. I do intend to follow up with a not a display editor in the tradition of InterLisp's DEdit. I do intend to follow up with a
display editor, but this is exploratory code. display editor, but this is exploratory proof-of-concept code.
To edit an arbitrary s-expression: To edit an arbitrary s-expression:
@ -19,19 +19,22 @@ To edit a function definition
(fedit 'name-of-function) (fedit 'name-of-function)
NOTE: This is broken, see working notes below; but it is showing promise.
## Still to do ## Still to do
### Function metadata ### Function metadata
Currently, Clojure metadata on a function symbol as follows: Currently, Clojure metadata on a function symbol as follows:
{
{
:arglists ([sexpr]), :arglists ([sexpr]),
:ns #<Namespace fedit.core>, :ns #<Namespace fedit.core>,
:name sedit, :column 1, :name sedit, :column 1,
:doc "Edit an S-Expression, and return a modified version of it", :doc "Edit an S-Expression, and return a modified version of it",
:line 74, :line 74,
:file "fedit/core.clj" :file "fedit/core.clj"
} }
In order to be able to recover the source of a function which has not yet been committed to the file In order to be able to recover the source of a function which has not yet been committed to the file
system, it would be necessary to store the source s-expression on the metadata. You cannot add new system, it would be necessary to store the source s-expression on the metadata. You cannot add new
@ -57,7 +60,7 @@ specified package available on the path.
At the end of a Clojure session (or, actually, at any stage within a session) the user could issue At the end of a Clojure session (or, actually, at any stage within a session) the user could issue
a directive a directive
(persist-edits) (persist-edits)
Until this directive had been called, none of the in-core edits which had been made in the session Until this directive had been called, none of the in-core edits which had been made in the session
would be saved. When the directive was made, the persister would go through all functions/symbols would be saved. When the directive was made, the persister would go through all functions/symbols