[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
bug#28781: 25.3; Override erroneous "incorrect verb voice" from checkdoc
From: |
Eli Zaretskii |
Subject: |
bug#28781: 25.3; Override erroneous "incorrect verb voice" from checkdoc |
Date: |
Tue, 10 Oct 2017 23:05:15 +0300 |
> From: Radon Rosborough <radon.neon@gmail.com>
> Date: Tue, 10 Oct 2017 12:44:05 -0700
> Cc: 28781@debbugs.gnu.org
>
> Is it recommended to have all function docstrings start with a verb?
Yes. From the ELisp manual, node "Documentation Tips"
For a function, the first line should briefly answer the question,
“What does this function do?” For a variable, the first line should
briefly answer the question, “What does this value mean?”
(It talks about the first line of the doc string.)
> If so, maybe the docstring for `functionp' should be changed (after
> all, it was what I modeled this one off of):
>
> Non-nil if OBJECT is a function.
Yes, I think so.