[slime-devel] Re: More slime.el fixes

[Lawrence Mitchell]

Luke Gorrie wrote:

[...]

>>>	(slime-same-line-p): Use `line-beginning-position' and
>>>	`line-end-position'.  Fix typo in docstring.

> This looks broken, I think it tests if two positions are on the same
> line as (point) rather than the same line as one another? I left that
> part out.

Ooops, yes, that was silly.


[...]

>> -\(when-let (VAR VALUE) &rest BODY)"
>> +\(fn (VAR VALUE) &rest BODY)"

> Why `fn' in these docstrings? (not committed)

In Emacs, at least, one uses \(fn ...) to specify a function
arglist.  Compare the help output for the two functions:

(defun foo (x &rest y)
  "do stuff.

\(foo (VAR1 VALUE1 ...) (FORM &rest IGNORED))")

(defun bar (x &rest y)
  "do stuff.

\(fn (VAR1 VALUE1 ...) (FORM &rest IGNORED))")


| foo is a Lisp function.
| (foo X &rest Y)

| do stuff.

| (foo (VAR1 VALUE1 ...) (FORM &rest IGNORED))

| bar is a Lisp function.
| (bar (VAR1 VALUE1 ...) (FORM &rest IGNORED))

| do stuff.

This convention is also picked up by things like eldoc, which
echoes the "specified" arglist, rather than the function's
actual arglist.

-- 
Lawrence Mitchell <wence at gmx.li>