Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation string follows a 'defun' name or setq 'var' in elisp but not in .spacem.template #5443

Closed
triklsbg opened this issue Mar 10, 2016 · 4 comments

Comments

@triklsbg
Copy link

In the setq sexp of the .spacemacs.template the documentation comment precedes (comes before) the coded variable name. In "normal" lisp the doc-string follows the definition. Depending on the chosen syntax highlighting this is more or less confusing in my opinion. Generally i would prefer the coded variable name before the docstring in this case the explaining comments.
You may call me nitpicking.;-)

@TheBB
Copy link
Contributor

TheBB commented Mar 10, 2016

I think we'd be doing ourselves a disfavour by moving them. It's a fairly widespread convention that comments come before the code that they are explaining.

We can't change the Emacs Lisp docstring conventions, however.

@TheBB
Copy link
Contributor

TheBB commented Mar 10, 2016

On the other hand, one thing I would like to see which I think would help is some empty lines.

@rgrinberg
Copy link
Contributor

@TheBB This can be closed then right?

@TheBB
Copy link
Contributor

TheBB commented Oct 24, 2016

Sure.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants