From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Jambunathan K Newsgroups: gmane.emacs.bugs Subject: bug#15852: 24.3.50; cperl-mode: Please audit the docstrings (before the next merge) Date: Sun, 10 Nov 2013 14:16:09 +0530 Message-ID: <87zjpcod9q.fsf@gmail.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1384073233 2739 80.91.229.3 (10 Nov 2013 08:47:13 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sun, 10 Nov 2013 08:47:13 +0000 (UTC) To: 15852@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Nov 10 09:47:18 2013 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1VfQft-0002o0-JF for geb-bug-gnu-emacs@m.gmane.org; Sun, 10 Nov 2013 09:47:17 +0100 Original-Received: from localhost ([::1]:59450 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VfQfs-0001Rk-Qa for geb-bug-gnu-emacs@m.gmane.org; Sun, 10 Nov 2013 03:47:16 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:41238) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VfQfj-0001RQ-Vp for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2013 03:47:13 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VfQfd-0000ar-VC for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2013 03:47:07 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:59446) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VfQfd-0000af-Rk for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2013 03:47:01 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1VfQfd-0003Y7-L9 for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2013 03:47:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Jambunathan K Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 10 Nov 2013 08:47:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 15852 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.138407317813586 (code B ref -1); Sun, 10 Nov 2013 08:47:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 10 Nov 2013 08:46:18 +0000 Original-Received: from localhost ([127.0.0.1]:45232 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VfQev-0003X4-LP for submit@debbugs.gnu.org; Sun, 10 Nov 2013 03:46:18 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:39407) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1VfQet-0003Ws-Rq for submit@debbugs.gnu.org; Sun, 10 Nov 2013 03:46:16 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VfQei-0000SE-Q1 for submit@debbugs.gnu.org; Sun, 10 Nov 2013 03:46:10 -0500 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:58963) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VfQei-0000SA-M7 for submit@debbugs.gnu.org; Sun, 10 Nov 2013 03:46:04 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:41096) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VfQeZ-0001OY-KC for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2013 03:46:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1VfQeT-0000OH-PU for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2013 03:45:55 -0500 Original-Received: from mail-pa0-x22e.google.com ([2607:f8b0:400e:c03::22e]:44258) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1VfQeT-0000M7-H2 for bug-gnu-emacs@gnu.org; Sun, 10 Nov 2013 03:45:49 -0500 Original-Received: by mail-pa0-f46.google.com with SMTP id kl14so2746657pab.19 for ; Sun, 10 Nov 2013 00:45:48 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=from:to:subject:date:message-id:mime-version:content-type; bh=e5jqigWk4PlClcsUK588xrCROFYwGa6ZbwWYCt3WOtE=; b=yfTyN7Ds+oFz5y/E43Uek5GQMfHOolpjoPc0XcfJzDQytb3cjc4mA7koG+11RplO4U rLzKQsxpcymTM8U8W0gddI9HbKSAYLUeQBrxNhAtRZNNIH2fan9z0W4YxtTSnlSUwiXH MJ10rjClIINIEe0lNNTV8Y+8zj5ue+//89vyW9jCRswz19guuclnCcb112mJ/UHH3p5Y HEKSohe5ihzxMKgkb/yM9chiOELTC9pG4hzZpmm2TKt37sa7+vPPcVKHq6O0wDV2EAVQ lqK0fvPWsW2mNIgRK3KwrKo3UETzCpeQGY5eFNXj6XOxsX8GHCp3CrxoozwCftdWpND+ 1qBw== X-Received: by 10.68.244.168 with SMTP id xh8mr23905208pbc.3.1384073148354; Sun, 10 Nov 2013 00:45:48 -0800 (PST) Original-Received: from debian-6.05 ([101.63.140.187]) by mx.google.com with ESMTPSA id gg10sm23162613pbc.46.2013.11.10.00.45.46 for (version=TLSv1.1 cipher=RC4-SHA bits=128/128); Sun, 10 Nov 2013 00:45:47 -0800 (PST) X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 140.186.70.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-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:80197 Archived-At: I am feeling like Drew Adams Junior. But here I go. ---------------------------------------------------------------- For example, what exactly does older mean. cperl-mode seems to have an history of atleast a decade. Please update docstring to the current state of the package as on 2013. > 10 matches for "older" in buffer: cperl-mode.el > 526:Older version of this page was called `perl5', newer `perl'." > 709:For best results apply to an older Emacs the patches from > 775: "Description of problems in CPerl mode specific for older Emacs versions. > 789:Even with older Emacsen CPerl mode tries to corrects some Emacs > 809:The solution is to upgrade your Emacs or patch an older one. Note > 1595:\(even with older Emacsen), `cperl-electric-lbrace-space' to t switches > 4110: bb (char-after (1- (match-beginning b1))) ; tmp holder > 5381: (insert (make-string dc ?-))))) ; Placeholder (to avoid splitting???) > 5827: ;; need to manually set 'multiline' for older font-locks > 8823: ;; Why needed??? With older font-locks??? ---------------------------------------------------------------- I have never seen the term Emacxen used before. > 5 matches for "\_" in buffer: cperl-mode.el > 747:Though with contemporary Emaxen CPerl mode should maintain the correct > 825:with old Emaxen which do not support `syntax-table' property. > 906:10) Uses a linear-time algorithm for indentation of regions (on Emaxen with > 931: A2) On capable Emaxen CPerl will use improved syntax-handling > 1631:here-docs sections. With capable Emaxen results of scan are used ---------------------------------------------------------------- Please remove Menu -> Perl -> Microdocs -> Praise, Problems etc. They qualify to be in file's Commentary section. ---------------------------------------------------------------- I have a bad feeling about docstrings in cperl-mode specifically C-h f cperl-mode. 1. It reads like loosely and bad structured, developer notes. 2. Some of the docstrings are in passive voice. ---------------------------------------------------------------- In GNU Emacs 24.3.50.4 (i686-pc-linux-gnu, GTK+ Version 2.20.1) of 2013-11-09 on debian-6.05 Bzr revision: 115051 jan.h.d@swipnet.se-20131109111953-cysfi19meuidy96q Windowing system distributor `The X.Org Foundation', version 11.0.10707000 System Description: Debian GNU/Linux 6.0.5 (squeeze)