From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#33664: 26.1; Document vars and functions in `cursor-sensor.el' Date: Fri, 07 Dec 2018 17:35:30 +0200 Message-ID: <83k1kl5ozh.fsf@gnu.org> References: NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1544196906 16127 195.159.176.226 (7 Dec 2018 15:35:06 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 7 Dec 2018 15:35:06 +0000 (UTC) Cc: 33664@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Dec 07 16:35:02 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gVI9c-00041K-Uu for geb-bug-gnu-emacs@m.gmane.org; Fri, 07 Dec 2018 16:35:01 +0100 Original-Received: from localhost ([::1]:46770 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gVIBj-0003nG-Lz for geb-bug-gnu-emacs@m.gmane.org; Fri, 07 Dec 2018 10:37:11 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:57988) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gVIAh-0003CA-Ha for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:36:08 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gVIAd-00007Y-Lc for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:36:07 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:32932) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1gVIAc-0008Ue-8X for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:36:03 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1gVIAc-00066L-3t for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:36:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 07 Dec 2018 15:36:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 33664 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 33664-submit@debbugs.gnu.org id=B33664.154419695223436 (code B ref 33664); Fri, 07 Dec 2018 15:36:02 +0000 Original-Received: (at 33664) by debbugs.gnu.org; 7 Dec 2018 15:35:52 +0000 Original-Received: from localhost ([127.0.0.1]:37190 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gVIAR-00065w-PW for submit@debbugs.gnu.org; Fri, 07 Dec 2018 10:35:51 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:48306) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gVIAQ-00065k-3w for 33664@debbugs.gnu.org; Fri, 07 Dec 2018 10:35:50 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gVIAH-0006uf-On for 33664@debbugs.gnu.org; Fri, 07 Dec 2018 10:35:45 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:53295) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gVIAH-0006uN-Kl; Fri, 07 Dec 2018 10:35:41 -0500 Original-Received: from [176.228.60.248] (port=1292 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1gVIAH-0001Z6-7D; Fri, 07 Dec 2018 10:35:41 -0500 In-reply-to: (message from Drew Adams on Fri, 7 Dec 2018 15:15:37 +0000 (UTC)) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:153177 Archived-At: > Date: Fri, 7 Dec 2018 15:15:37 +0000 (UTC) > From: Drew Adams > > Please document the variables and functions in `cursor-sensor.el'. It > would be a step backward for Emacs to document less and less. Calling > something an "internal" function is not, in itself, a sufficient reason > not to give it a doc string. > > In particular, please add a doc string for variable > `cursor-sensor-inhibit'. > > I was reading the `isearch.el' code and saw this: (push 'isearch > cursor-sensor-inhibit). Had to start searching `cursor-sensor.el' to > try to understand what this variable is for. Even that didn't really > help, since there is nothing in `cursor-sensor.el' that would lead one > to understand that the variable is used somehow as a list of values. > > Even grepping for that var didn't help with such understanding, as there > are no uses of it outside of isearch.el. > > Isearch apparently goes to the trouble of allowing for the var to be > used as a list (similar to `buffer-invisibility-spec', perhaps), but > there is no comment, doc, or spec describing this behavior/use in > `cursor-sensor.el'. AFAIK, about the only person who could do something about this doesn't read bug reports.