@@ -9,7 +9,8 @@ read-eval-print loop, but different. To try it out, first install halp.el as described below. Then visit a suitable file, (like sample.py, sample.lhs, or sample.sh in this directory), and hit M-i. These sample files will explain what you can -do and how it works. (XXX actually they don't yet) +do and how it works. (Actually only sample.py explains much. But for +the other languages, currently, there's little to explain.) INSTALLING README @@ -1,3 +1,5 @@ +add doc comments to interactive elisp functions + We're still getting 'File "<string>", line 14' on syntax errors. It looks like that message comes out of the SyntaxError exception rather than the traceback. I tried setting value.filename = halp_filename TODO @@ -1,4 +1,4 @@ -# Hello, this is a sample. +# To use Halp, edit an ordinary Python source file like this one. def fact(n): if n <= 0: @@ -6,8 +6,38 @@ def fact(n): else: return n * fact(n - 1) -# When you hit M-i you should see '#. 120' appear below the following line: +# Given comments starting with '## ' like this: +## 2 + 3 + +# Halp will evaluate them when you hit M-i, and insert their value +# below them in another comment (but prefixed with '#. ' instead. Try +# it now. You should see '#. 5' appear below the line above, and +# '#. 120' appear below the following line: ## fact(2 + 3) -# OK. +# If you want, you can make those lines go away by hitting Undo. But +# you need not; since the outputs are comments they can be left in +# place, where the next M-i will replace them with any new results. + +# Your ## lines can be statements, too: + +## print 'hello\nworld' + +# If they raise exceptions, a traceback appears: + +## fact('notanumber') + +# If there's an error loading this source file (never mind the ## +# lines) you'll get an error message inserted right at the point of +# the error, and no attempt to evaluate ## lines. You can see this +# happening by uncommenting the following line: + +#foo + +# Finally, you can make the output a function of the previous +# output using halp.read(). This makes it possible to make a +# program's source code the 'user interface' to the program. + +## 2 * int(halp.read()) +#. 1 sample.py 7b226d09846d7a9b5181496b37a6f9b4f8dd8243 darius darius@darius-bacons-macbook.local http://github.com/darius/halp/commit/93e3a850aa43f5b404949a916a7851d85806303f 93e3a850aa43f5b404949a916a7851d85806303f 2008-09-18T20:49:03-07:00 2008-09-18T20:49:03-07:00 explain all our features in sample.py 0450b0a8d6025b34ae4415ecb0c690060e4b4913 darius darius@darius-bacons-macbook.local