From: Dmitry Gutov <dgutov@yandex.ru>
Date: Mon, 20 Jul 2020 01:07:11 +0000 (+0300)
Subject: ; project.el: Talk about equality
X-Git-Tag: emacs-28.0.90~6960
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=4c08c2f45b9bb0265f6d7c3529011dee1b18e843;p=emacs.git

; project.el: Talk about equality
---

diff --git a/lisp/progmodes/project.el b/lisp/progmodes/project.el
index 49a773539c0..a0930553bd7 100644
--- a/lisp/progmodes/project.el
+++ b/lisp/progmodes/project.el
@@ -95,8 +95,11 @@
 ;;
 ;; - Choose the format of the value that represents a project for your
 ;; backend (we call it project instance).  Don't use any of the
-;; formats from other backends.  The value can be arbitrary, as long
-;; as the datatype is something `cl-defmethod' can dispatch on.
+;; formats from other backends.  The format can be arbitrary, as long
+;; as the datatype is something `cl-defmethod' can dispatch on.  The
+;; value should be stable (when compared with `equal') across
+;; invocations, meaning calls to that function from buffers belonging
+;; to the same project should return equal values.
 ;;
 ;; - Write a new function that will determine the current project
 ;; based on the directory and add it to `project-find-functions'