Suggest changing lisp-indent-function #1602
Conversation
CONTRIBUTING.org
Outdated
| It is provided for you in [[https://github.com/abo-abo/swiper/blob/master/.dir-locals.el][.dir-locals.el]], please obey it. | ||
|
|
||
| The setting for =indent-tabs-mode= is automatically applied by | ||
| =.dir-locals.el=. In Emacs 26, you can apply the setting for |
There was a problem hiding this comment.
What is the significance of Emacs version 26? Doesn't the suggestion work in prior versions?
Nitpick: please honour the sentence-end-double-space setting in the project's dir-locals-file.
There was a problem hiding this comment.
.dir-locals-2.el support was added only in Emacs 26. I'll fix the sentence spacing, sorry about that.
There was a problem hiding this comment.
Wait, on second thought—the rest of the file also uses single spaces after periods! I could fix the rest of it as well, though.
There was a problem hiding this comment.
.dir-locals-2.elsupport was added only in Emacs 26
Right, but there's never been something stopping users from modifying .dir-locals.el directly. My point is that the current wording suggests the entire recipe ((add-to-list ...) included) is specific to Emacs 26, when only the .dir-locals-2.el suggestion is.
CONTRIBUTING.org
Outdated
| #+end_src | ||
| It is provided for you in [[https://github.com/abo-abo/swiper/blob/master/.dir-locals.el][.dir-locals.el]], please obey it. | ||
|
|
||
| The setting for =indent-tabs-mode= is automatically applied by |
There was a problem hiding this comment.
Shouldn't code be marked up with tildes? I.e. ~indent-tabs-mode~, ~lisp-indent-function~, etc.
There was a problem hiding this comment.
The rest of the file uses = monospace rather than ~ code. I could change that, too, though.
There was a problem hiding this comment.
The rest of the file uses
=monospace rather than~code. I could change that, too, though.
Silliness aside, I'd like to know whether there's a good reason to use = for everything. If there isn't, then I'd prefer to use ~ where appropriate. This can, of course, be done at a later time, but if we agree on using ~, then we might as well use it for any new additions.
There was a problem hiding this comment.
Actually, within many of my projects I've made an ad-hoc convention that ~...~ should be used as equivalent of <kbd>...</kbd> in Markdown. With a bit of customization, these tags will be properly exported both in HTML and in Info. So I'd like to keep ~...~ exclusively for keyboard shortcuts.
CONTRIBUTING.org
Outdated
| #+end_src | ||
|
|
||
| to your init-file, copying =.dir-locals.el= to =.dir-locals-2.el=, and | ||
| uncommenting the line in that file which sets =lisp-indent-function=. |
There was a problem hiding this comment.
If we really are going to go full common-lisp-indent-function (on which decision I've commented in #1601), wouldn't it make more sense to uncomment the correspoding dir-locals-file line?
There was a problem hiding this comment.
By default, Emacs complains about the unsafe file-local variable, every time you open any file in the repository. That seems overly annoying, although my mind could be changed here.
There was a problem hiding this comment.
By default, Emacs complains about the unsafe file-local variable, every time you open any file in the repository. That seems overly annoying
Indeed, which is why I thought we were suggesting the safe-local-variable-values spiel. I realise now, though, that "normal" users (i.e. users not hacking on Swiper) deserve to not have to play with safe-local-variable-values in order to quietly read the Swiper sources.
raxod502
force-pushed
the
feat/lisp-indent-function
branch
from
c4b9fe1
to
a8ecca6
Compare
|
I changed the sentences to end with two spaces, replaced |
|
Thanks. |
CONTRIBUTING.org: Suggest common-lisp-indent-function setting similar to that of lisp-indent-function. counsel.el (counsel--push-xref-marker): ivy.el (ivy--dirname-p): Reindent accordingly. Re: abo-abo#1601, abo-abo#1602, abo-abo#1612
See also #1601.