From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Stefan Monnier Newsgroups: gmane.emacs.bugs Subject: bug#7521: 24.0.50; doc for `delimit-columns-*' Date: Sun, 03 Jul 2011 21:08:23 -0400 Message-ID: References: <6AF7D745DDFA44439FAE15E2647441AF@us.oracle.com> <06B232927CEE40FC91F8398F1EFDDF97@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: dough.gmane.org 1309742010 26473 80.91.229.12 (4 Jul 2011 01:13:30 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Mon, 4 Jul 2011 01:13:30 +0000 (UTC) Cc: 7521@debbugs.gnu.org, 'Lars Magne Ingebrigtsen' To: "Drew Adams" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jul 04 03:13:26 2011 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1QdXj2-0001Hq-1d for geb-bug-gnu-emacs@m.gmane.org; Mon, 04 Jul 2011 03:13:24 +0200 Original-Received: from localhost ([::1]:37162 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QdXj1-0007xS-4J for geb-bug-gnu-emacs@m.gmane.org; Sun, 03 Jul 2011 21:13:23 -0400 Original-Received: from eggs.gnu.org ([140.186.70.92]:51490) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QdXer-0007Gu-MY for bug-gnu-emacs@gnu.org; Sun, 03 Jul 2011 21:09:06 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1QdXep-00054D-Fg for bug-gnu-emacs@gnu.org; Sun, 03 Jul 2011 21:09:05 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:53997) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1QdXep-000541-1n for bug-gnu-emacs@gnu.org; Sun, 03 Jul 2011 21:09:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1QdXeo-0001NQ-Hk; Sun, 03 Jul 2011 21:09:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Monnier Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 04 Jul 2011 01:09:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 7521 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 7521-submit@debbugs.gnu.org id=B7521.13097417115238 (code B ref 7521); Mon, 04 Jul 2011 01:09:02 +0000 Original-Received: (at 7521) by debbugs.gnu.org; 4 Jul 2011 01:08:31 +0000 Original-Received: from localhost ([127.0.0.1] helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QdXeI-0001MR-VT for submit@debbugs.gnu.org; Sun, 03 Jul 2011 21:08:31 -0400 Original-Received: from ironport2-out.teksavvy.com ([206.248.154.183] helo=ironport2-out.pppoe.ca) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1QdXeH-0001MG-BY for 7521@debbugs.gnu.org; Sun, 03 Jul 2011 21:08:29 -0400 X-IronPort-Anti-Spam-Filtered: true X-IronPort-Anti-Spam-Result: Av0EAPMREU5FxIxr/2dsb2JhbABSp3t4iHrBdYY2BJ5chCw X-IronPort-AV: E=Sophos;i="4.65,469,1304308800"; d="scan'208";a="120222799" Original-Received: from 69-196-140-107.dsl.teksavvy.com (HELO pastel.home) ([69.196.140.107]) by ironport2-out.pppoe.ca with ESMTP/TLS/ADH-AES256-SHA; 03 Jul 2011 21:08:23 -0400 Original-Received: by pastel.home (Postfix, from userid 20848) id 6944A59173; Sun, 3 Jul 2011 21:08:23 -0400 (EDT) In-Reply-To: <06B232927CEE40FC91F8398F1EFDDF97@us.oracle.com> (Drew Adams's message of "Sat, 2 Jul 2011 08:21:40 -0700") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.0.50 (gnu/linux) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Sun, 03 Jul 2011 21:09:02 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) 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:47903 Archived-At: >> > You cannot understand a thing about commands >> > `delimit-columns-region' and `delimit-columns-rectangle' >> > without reading the commentary in Lisp >> > file delim-col.el. In sum, there is no help for users - no doc. >> I suspect that the workings of delim-col.el are too complicated to be >> explained in a doc string for any of the commands. If these commands >> are to be useful to users, I think the proper solution is to document >> them in the elisp manual. > You might be right; I really don't know. My take is that these things > are explained in the source-code comments, and that this info needs to > be made available to users via help/doc. If the details get > transferred to the manual, OK. The Elisp manual does not document all Elisp features and packages. Some packages come with their own manual, and others put their documentation in the Commentary section. IOW, I think the current situation where the doc for delim-col.el is in the Commentary section is "about right". I know that the commentary section may seem "hidden away in the source", but the solution is not to move it elsewhere, but to make it easier to access the Commentary section. Stefan