From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.bugs Subject: bug#33664: 26.1; Document vars and functions in `cursor-sensor.el' Date: Fri, 7 Dec 2018 15:15:37 +0000 (UTC) Message-ID: NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1544195653 3016 195.159.176.226 (7 Dec 2018 15:14:13 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Fri, 7 Dec 2018 15:14:13 +0000 (UTC) To: 33664@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Dec 07 16:14:09 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 1gVHpO-0000Ys-U6 for geb-bug-gnu-emacs@m.gmane.org; Fri, 07 Dec 2018 16:14:07 +0100 Original-Received: from localhost ([::1]:46692 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gVHrV-0007QA-8X for geb-bug-gnu-emacs@m.gmane.org; Fri, 07 Dec 2018 10:16:17 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:53084) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gVHrO-0007Q3-HW for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:16:11 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gVHrI-0005gB-PU for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:16:10 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:32899) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1gVHrG-0005So-Qa for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:16:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1gVHrG-0005b7-IL for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:16:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 07 Dec 2018 15:16:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 33664 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.154419575521494 (code B ref -1); Fri, 07 Dec 2018 15:16:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 7 Dec 2018 15:15:55 +0000 Original-Received: from localhost ([127.0.0.1]:37156 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gVHr8-0005ac-Pm for submit@debbugs.gnu.org; Fri, 07 Dec 2018 10:15:55 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:43392) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1gVHr6-0005aO-2l for submit@debbugs.gnu.org; Fri, 07 Dec 2018 10:15:52 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gVHr0-0004IP-2Y for submit@debbugs.gnu.org; Fri, 07 Dec 2018 10:15:46 -0500 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:42488) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gVHqz-0004IF-Ud for submit@debbugs.gnu.org; Fri, 07 Dec 2018 10:15:45 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:52995) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gVHqz-0007Np-44 for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:15:45 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gVHqv-0003y5-2m for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:15:45 -0500 Original-Received: from userp2130.oracle.com ([156.151.31.86]:40900) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gVHqu-0003rW-Pb for bug-gnu-emacs@gnu.org; Fri, 07 Dec 2018 10:15:41 -0500 Original-Received: from pps.filterd (userp2130.oracle.com [127.0.0.1]) by userp2130.oracle.com (8.16.0.22/8.16.0.22) with SMTP id wB7F8nIF165992 for ; Fri, 7 Dec 2018 15:15:39 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=oracle.com; h=mime-version : message-id : date : from : sender : to : subject : content-type : content-transfer-encoding; s=corp-2018-07-02; bh=uTBFoHVMW+noBYspOKKEovXTVWzOhKGfQQ+l2y3Ax+M=; b=jQhRHtHu5bkWBOCrKE7NXk4C28UgGamT7+noq/2B/7gNlLPyewp5axdhlENNGRmcIZUp iGNlQbmROYHHcumiHWa5sWgU2S7gpSOsOeIciGOHMhzunqXdAWthCXOY0O9bwQWT8Nh8 P78ul9yGST3lipiw3fWbfHBDgDBEe72Md+59RqSUuJf0d4nPCjl9iQbPvay7IF7JG0Kr YtaKCNM6fBcJkveFPaR8l/t43SvdsIaBbKtvjZDmoevQJ7f+l5UNiiR88qq1A+KV4r2J ndN1ATOv/sHKMiIiJX+BU2OVmooG5Ue+ziiB3yYNB0xZr3FSxlbKlokW6CZ9pf6l/ag4 qg== Original-Received: from userv0021.oracle.com (userv0021.oracle.com [156.151.31.71]) by userp2130.oracle.com with ESMTP id 2p3hquedey-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Fri, 07 Dec 2018 15:15:39 +0000 Original-Received: from userv0121.oracle.com (userv0121.oracle.com [156.151.31.72]) by userv0021.oracle.com (8.14.4/8.14.4) with ESMTP id wB7FFceG030317 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-GCM-SHA384 bits=256 verify=OK) for ; Fri, 7 Dec 2018 15:15:38 GMT Original-Received: from abhmp0020.oracle.com (abhmp0020.oracle.com [141.146.116.26]) by userv0121.oracle.com (8.14.4/8.13.8) with ESMTP id wB7FFchh026942 for ; Fri, 7 Dec 2018 15:15:38 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9.1 (1003210) [OL 16.0.4771.0 (x86)] X-Proofpoint-Virus-Version: vendor=nai engine=5900 definitions=9099 signatures=668679 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 suspectscore=1 malwarescore=0 phishscore=0 bulkscore=0 spamscore=0 mlxscore=0 mlxlogscore=999 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.0.1-1810050000 definitions=main-1812070122 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [generic] [fuzzy] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x 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:153173 Archived-At: 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'. In GNU Emacs 26.1 (build 1, x86_64-w64-mingw32) of 2018-05-30 Repository revision: 07f8f9bc5a51f5aa94eb099f3e15fbe0c20ea1ea Windowing system distributor `Microsoft Corp.', version 10.0.16299 Configured using: `configure --without-dbus --host=3Dx86_64-w64-mingw32 --without-compress-install 'CFLAGS=3D-O2 -static -g3''