emacscollective / auto-compile

Automatically compile Emacs Lisp libraries
GNU General Public License v3.0
172 stars 16 forks source link

Remove declarations forgotten during recent autoload-* removal #30

Closed stepnem closed 1 year ago

stepnem commented 1 year ago

And some typo fixes on top.

tarsius commented 1 year ago

Thanks!

This somehow fell through the cracks.

I replaced doc-string with docstring, instead of doc string as you suggested. docstring is how it is spelled in Emacs' own documentation.

The first dropped to was clearly a mistake. The second not so much. I am going to stick to to, even though it is the less common form. For reference:

stepnem commented 1 year ago

docstring is how it is spelled in Emacs' own documentation.

[citation needed]

The official term is "documentation string", "doc string" for short. That's how it's indexed in the manuals (only the former in the Emacs manual, both in the Elisp reference manual).

"docstring" does occur, but more often as an Elisp identifier (symbol).

tarsius commented 1 year ago

[citation needed]

Grepping for the three forms shows that both "doc string" and "docstring" are being used. I consistently used "doc-string" until someone pointed out to me that "docstring" is what should be used. I believe it was Stefan or Eli. I am going to stick to that until someone points me to official documentation that says what should be used instead. I don't want to research it myself.