emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Thorsten Jolitz <tjolitz@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: What does the _ in `(defun org-element-section-parser (_) ...)' stands for?
Date: Wed, 10 Feb 2016 21:13:04 +0100	[thread overview]
Message-ID: <87r3gkgw8f.fsf@gmail.com> (raw)
In-Reply-To: m2vb5x90bc.fsf@andrew.cmu.edu

John Kitchin <jkitchin@andrew.cmu.edu> writes:

> I guess it is a required signature for the function (i.e. some other
> function will call it with some argument), and _ indicates it is not
> used in the body. If you were to give it the arg a name, then checkdoc
> would complain about it not being in the docstring.

Sounds reasonable, thanks for the explanation.
But it does not seem to be a true guess, I tried it out with:

#+BEGIN_SRC emacs-lisp
(defun my-foo (_)
  "Hello World.
Argument _ unknown argument."
  (+ 1 1))
#+END_SRC

and checkdoc asked me to add the "Argument ..." part for "_" to the docstring.

I don't remember that I've seen this before, so maybe this is a rather new
feature/convention?

> Thorsten Jolitz writes:
>
>> Hi List,
>> just out of curiosity, a few functions in org-element.el contain _ in
>> their parameter list, but its not used in the body.
>> What does it stand for?
>
>
> --
> Professor John Kitchin
> Doherty Hall A207F
> Department of Chemical Engineering
> Carnegie Mellon University
> Pittsburgh, PA 15213
> 412-268-7803
> @johnkitchin
> http://kitchingroup.cheme.cmu.edu
>
>

-- 
cheers,
Thorsten

  reply	other threads:[~2016-02-10 20:13 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-02-09 17:45 What does the _ in `(defun org-element-section-parser (_) ...)' stands for? Thorsten Jolitz
2016-02-09 18:59 ` John Kitchin
2016-02-10 20:13   ` Thorsten Jolitz [this message]
2016-02-10 20:47     ` John Kitchin
2016-02-11 17:10       ` Thorsten Jolitz
2016-02-11 17:20         ` John Kitchin
2016-02-11 17:33         ` Nick Dokos
2016-02-14 16:45           ` John Kitchin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87r3gkgw8f.fsf@gmail.com \
    --to=tjolitz@gmail.com \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).