bug#26564: Document that only functions and not variables can end with "-p"

[Kaushal Modi]

On Wed, Apr 19, 2017 at 12:08 PM Eli Zaretskii <eliz@gnu.org> wrote:

> What would be the correct section to do so?

"Coding Conventions", of course.

Please review this patch:

From 9749603b7c3ba45c9c81f9624d6dc42f740aee39 Mon Sep 17 00:00:00 2001

From: Kaushal Modi <kaushal.modi@gmail.com>

Date: Wed, 19 Apr 2017 12:20:05 -0400

Subject: [PATCH] Document convention to reserve "p" or "-p" suffix for

 predicate fns

* doc/lispref/tips.texi (Coding Conventions): The "p" or "-p" suffix

  should be used for only predicate functions, and not

  variables.  (Bug#26564)

---

 doc/lispref/tips.texi | 4 +++-

 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/doc/lispref/tips.texi b/doc/lispref/tips.texi

index 4e2a0fad1f..ec76fcb5ce 100644

--- a/doc/lispref/tips.texi

+++ b/doc/lispref/tips.texi

@@ -154,7 +154,9 @@ Coding Conventions

 condition is true or false, give the function a name that ends in

 @samp{p} (which stands for ``predicate'').  If the name is one word,

 add just @samp{p}; if the name is multiple words, add @samp{-p}.

-Examples are @code{framep} and @code{frame-live-p}.

+Examples are @code{framep} and @code{frame-live-p}.  This predicate

+suffix should not be used in variable names (i.e., you might name a

+variable @code{foo-feature} instead of @code{foo-feature-p}).

 

 @item

 If the purpose of a variable is to store a single function, give it a

-- 

2.11.0

 

--

Kaushal Modi