In slime.el what do the comments ";; Interface" before certain functions mean? That they are part of the user interface or part of the SLIME/SWANK interface? Or something else?
-Peter
Peter Seibel peter@gigamonkeys.com writes:
In slime.el what do the comments ";; Interface" before certain functions mean? That they are part of the user interface or part of the SLIME/SWANK interface? Or something else?
I think I put that in to copy-cat the CMUCL sources. The intention was to indicate that the function is an entry-point and not just a helper, i.e. that it's important and exported from the package.
These days defslimefun and defimplementation tend to take care of that job though.
I like to put subroutines lexically beneath their caller so sometimes I put in little reminders of which is the "top" function.
Luke Gorrie luke@synap.se writes:
Peter Seibel peter@gigamonkeys.com writes:
In slime.el what do the comments ";; Interface" before certain functions mean? That they are part of the user interface or part of the SLIME/SWANK interface? Or something else?
I think I put that in to copy-cat the CMUCL sources.
In elisp code?
-Peter
Peter Seibel peter@gigamonkeys.com writes:
Luke Gorrie luke@synap.se writes:
Peter Seibel peter@gigamonkeys.com writes:
I think I put that in to copy-cat the CMUCL sources.
In elisp code?
Those comments are only there to say "of the related functions you see here this is the one you should call, the others are subroutines".
In 'cvs annotate' it says I added all the Interface comments at the same time in version 1.372. The start of my checkin comment is:
Major refactoring.
Restructured and documented starting at the top of the file and going down through the networking protocol.
IIRC this was leading into SLIME 1.0 I was printing out the sources and reading them with a red pen to try and make them as intelligible as possible. I think that particular effort stopped about 20% of the way through slime.el because I was introducing too many bugs :-)
You might try doing this in slime.el btw:
M-x occur ^;;;;+
see also "Source Code Layout" in the HACKING file.
That any help?
Luke Gorrie luke@synap.se writes:
see also "Source Code Layout" in the HACKING file.
.. I didn't want to sound like a crackpot so I didn't mention that you can also feed slime through this program:
http://fresh.homeunix.net/~luke/misc/emacs/pbook.el http://fresh.homeunix.net/~luke/misc/emacs/pbook.pdf
but you probably need to do this first:
(setq pbook-heading-regexp "^;;;\(;+\)") (setq pbook-commentary-regexp "^;;;\($\|[^;]\)")
and I make no claim of usefulness about the result.
Just one of the many curious programming experiments during slime hacking. My favourite is the "pair programming" variant that me and Helmut did throughout the early days - taking it in turns every day or two to rewrite some major subsystem (e.g. the network protocol) and then see how the other guy rewrites it next. That was really the most fun hacking I've ever done (Cheers Helmut :-)
Cheers, Luke
-
Luke Gorrie -
Peter Seibel