From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: bug#7217: 24.0.50; no doc strings for regexp-opt functions Date: Fri, 15 Oct 2010 13:31:00 -0700 Message-ID: References: <52B72F87C25E4A2B98421CCC7E7718E4@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1287175350 16002 80.91.229.12 (15 Oct 2010 20:42:30 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 15 Oct 2010 20:42:30 +0000 (UTC) Cc: 7217@debbugs.gnu.org To: "'Stefan Monnier'" Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Oct 15 22:42:29 2010 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1P6r6i-0003FI-6P for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Oct 2010 22:42:28 +0200 Original-Received: from localhost ([127.0.0.1]:46765 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1P6r6h-0004BG-HL for geb-bug-gnu-emacs@m.gmane.org; Fri, 15 Oct 2010 16:42:27 -0400 Original-Received: from [140.186.70.92] (port=33334 helo=eggs.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1P6r6b-0004BB-Ek for bug-gnu-emacs@gnu.org; Fri, 15 Oct 2010 16:42:22 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1P6r6a-0006ed-FB for bug-gnu-emacs@gnu.org; Fri, 15 Oct 2010 16:42:21 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:39531) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1P6r6a-0006eZ-D4 for bug-gnu-emacs@gnu.org; Fri, 15 Oct 2010 16:42:20 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.69) (envelope-from ) id 1P6qti-0000rE-17; Fri, 15 Oct 2010 16:29:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-To: owner@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 15 Oct 2010 20:29:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 7217 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 7217-submit@debbugs.gnu.org id=B7217.12871745073285 (code B ref 7217); Fri, 15 Oct 2010 20:29:01 +0000 Original-Received: (at 7217) by debbugs.gnu.org; 15 Oct 2010 20:28:27 +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 1P6qt8-0000qw-Uf for submit@debbugs.gnu.org; Fri, 15 Oct 2010 16:28:27 -0400 Original-Received: from rcsinet10.oracle.com ([148.87.113.121]) by debbugs.gnu.org with esmtp (Exim 4.69) (envelope-from ) id 1P6qt7-0000qr-Gh for 7217@debbugs.gnu.org; Fri, 15 Oct 2010 16:28:25 -0400 Original-Received: from acsinet15.oracle.com (acsinet15.oracle.com [141.146.126.227]) by rcsinet10.oracle.com (Switch-3.4.2/Switch-3.4.2) with ESMTP id o9FKVwJs021306 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Fri, 15 Oct 2010 20:31:59 GMT Original-Received: from acsmt354.oracle.com (acsmt354.oracle.com [141.146.40.154]) by acsinet15.oracle.com (Switch-3.4.2/Switch-3.4.1) with ESMTP id o9FGT4h1003121; Fri, 15 Oct 2010 20:31:57 GMT Original-Received: from abhmt004.oracle.com by acsmt355.oracle.com with ESMTP id 689075371287174664; Fri, 15 Oct 2010 13:31:04 -0700 Original-Received: from dradamslap1 (/10.159.229.233) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Fri, 15 Oct 2010 13:31:03 -0700 X-Mailer: Microsoft Office Outlook 11 In-Reply-To: X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.5994 Thread-Index: ActspFxZuR4qkFYISmSlVUjMKqWijgAApJng X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.11 Precedence: list Resent-Date: Fri, 15 Oct 2010 16:29:02 -0400 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) 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: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:40914 Archived-At: > > Please provide doc strings for the so-called "workhorse" regexp-opt > > functions. They are important enough for users that I see > > them used in 3rd-party libraries. > > > regexp-opt-group > > regexp-opt-charset > > Maybe regexp-opt-charset makes sense in 3rd party libraries (the same > functionality is also re-implemented in rx.el and sregex.el, > IIRC), but I can't think of any reason to use regexp-opt-group. > > So I agree for regexp-opt-charset and would also like to see > it used in rx.el and friends, Sounds good to me. r-o-c was in fact the one I came across in a 3rd-party library - I should have said "it", not "them". (However, I cannot see any reason _not_ to give doc strings to both. I understand that you feel that way about "internal" functions. I don't. Doc strings make it easier to read code. If a block comment at the beginning of a function to describe it is useful for reading the code, then turn it into a doc string so it becomes easier to access. In the 1980s there was also a desire to save some space/memory, but that should no longer be a consideration wrt doc strings.)