From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: npostavs@users.sourceforge.net Newsgroups: gmane.emacs.bugs Subject: bug#25193: [PATCH] Improve the doc of re-search-forward and re-search-backward. Date: Sun, 02 Apr 2017 00:42:57 -0400 Message-ID: <87o9wfxvvy.fsf@users.sourceforge.net> References: <1481599231-19381-1-git-send-email-hong@topbug.net> <87mvg0pcnc.fsf@gmail.com> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: blaine.gmane.org 1491108142 17218 195.159.176.226 (2 Apr 2017 04:42:22 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sun, 2 Apr 2017 04:42:22 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.2 (gnu/linux) Cc: Hong Xu , 25193@debbugs.gnu.org To: Tino Calancha Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sun Apr 02 06:42:14 2017 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 1cuXL9-0003CO-Rl for geb-bug-gnu-emacs@m.gmane.org; Sun, 02 Apr 2017 06:42:11 +0200 Original-Received: from localhost ([::1]:53664 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cuXLE-000495-26 for geb-bug-gnu-emacs@m.gmane.org; Sun, 02 Apr 2017 00:42:16 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:59787) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cuXL5-00048w-Ih for bug-gnu-emacs@gnu.org; Sun, 02 Apr 2017 00:42:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cuXL0-0003lD-Kd for bug-gnu-emacs@gnu.org; Sun, 02 Apr 2017 00:42:07 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:58080) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1cuXL0-0003l5-Fj for bug-gnu-emacs@gnu.org; Sun, 02 Apr 2017 00:42:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1cuXL0-0003Pd-4U for bug-gnu-emacs@gnu.org; Sun, 02 Apr 2017 00:42:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: npostavs@users.sourceforge.net Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sun, 02 Apr 2017 04:42:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 25193 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 25193-submit@debbugs.gnu.org id=B25193.149110810013092 (code B ref 25193); Sun, 02 Apr 2017 04:42:02 +0000 Original-Received: (at 25193) by debbugs.gnu.org; 2 Apr 2017 04:41:40 +0000 Original-Received: from localhost ([127.0.0.1]:56279 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cuXKe-0003P5-D1 for submit@debbugs.gnu.org; Sun, 02 Apr 2017 00:41:40 -0400 Original-Received: from mail-io0-f195.google.com ([209.85.223.195]:34487) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cuXKd-0003Ou-Mt for 25193@debbugs.gnu.org; Sun, 02 Apr 2017 00:41:40 -0400 Original-Received: by mail-io0-f195.google.com with SMTP id n76so9363344ioe.1 for <25193@debbugs.gnu.org>; Sat, 01 Apr 2017 21:41:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=c0X/ojUK2VflvUsqCibxdD7SJO+hOTy2O+2duu/EGTY=; b=alWhVn8OoUBYecec6rt9c7Pw0bS+CY9ZpTNx1pnoVFMHfLU2uGpsOzR3xFh7mM+mh4 1onML/JVrSOrRbquGnkBuAxPk9ezLw5XVfl9Y63DisYCksCt5KKxWRytL5nFwqxYk5/M t7Z2QPQgzt4TW1aFL0SRlp6eARpIPxHRDdQ16hrqc0BuEtqTCK7401U10p305f61xuQR nTxdYeGlK0ZKQ2k9CyZf0Mk8TQmEAbYHOFGo6sy6ElPq7JRPVpVYXP/4Rp4Af8NzWveF kt6tLPpZzDQUNxFf3Two3xPbqGE7I7VN4ynkg3GyGakiIDLLY/3r6iGLpHdVA5ZYnFiS Ko/g== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:references:date :in-reply-to:message-id:user-agent:mime-version; bh=c0X/ojUK2VflvUsqCibxdD7SJO+hOTy2O+2duu/EGTY=; b=soyr33TgG7gP9/VZQthD4Ux8erNAW8Qd0qsmVzLrZyrTvv/v87vdD+Zsr8IpH4XKxB 9KGuiKb5d/andZYjL90whMyoEl7/5RS/BFA42sZQLNUiBpGdcGhgKVQagdA1gkHRMVSj FBbsBECOprEBYXxeM9rbN/ieGXnJscL4qIH/9+rq9ptvBLSJLc1RK9nmkQ6NLPlT0PSt FaPQ06AMse+j54akufJGON5HU8mwLrNrwbIXyAVyXiO0uGVIkdLwVRJpWGntspqr9UVz V5ju2/IdvXnK/NX9Bl7u2pAvG1TIO5QgerGYjuAZ7sPrPF7VW37oWXKKBr0GvgPpOiLO 1Jkw== X-Gm-Message-State: AFeK/H3rDEGne5/V8mCXkImyEaEB/6nzDqiix/GgCXie5aDYx4DP3mwS1xyo/HnmeGYBoQ== X-Received: by 10.107.35.211 with SMTP id j202mr11123223ioj.158.1491108094225; Sat, 01 Apr 2017 21:41:34 -0700 (PDT) Original-Received: from zony ([45.2.7.65]) by smtp.googlemail.com with ESMTPSA id o97sm5760221ioi.53.2017.04.01.21.41.32 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Sat, 01 Apr 2017 21:41:33 -0700 (PDT) In-Reply-To: <87mvg0pcnc.fsf@gmail.com> (Tino Calancha's message of "Tue, 13 Dec 2016 15:27:03 +0900") 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:131200 Archived-At: Tino Calancha writes: > Thanks for the report. > You could refer for details to the manual, maybe providing a link to the > proper node; but you don't want to refer to the doc string of another > function 'B' to document the arguments of the current function 'A'. > IMO the doc string of 'A' must introduce all its arguments. > > Otherwise, i am worry you could go an step further, f.i. > `search-forward'/ `search-backward' share the same optional arguments, so: I think it's okay to point to other functions, as long as we keep the chain to length 1. > 1) doc string `re-search-backward': See the doc string of `re-search-forward' > for details. > 2) doc string `re-search-forward': See the doc string of > `search-backward' for details. > 3) doc string `search-backward': See the doc string of > `search-forward' for details. > 4) doc string `search-forward': Wow, you are are very persistent > user! Please see the manual for details, i am a very busy doc string. :D But if all of `re-search-backword', re-search-forward', `search-backward', would say "see doc string of `search-forward'" I think it would be okay.