From: npostavs@users.sourceforge.net
To: Tino Calancha <tino.calancha@gmail.com>
Cc: Hong Xu <hong@topbug.net>, 25193@debbugs.gnu.org
Subject: bug#25193: [PATCH] Improve the doc of re-search-forward and re-search-backward.
Date: Sun, 02 Apr 2017 00:42:57 -0400 [thread overview]
Message-ID: <87o9wfxvvy.fsf@users.sourceforge.net> (raw)
In-Reply-To: <87mvg0pcnc.fsf@gmail.com> (Tino Calancha's message of "Tue, 13 Dec 2016 15:27:03 +0900")
Tino Calancha <tino.calancha@gmail.com> 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.
next prev parent reply other threads:[~2017-04-02 4:42 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-12-13 3:20 bug#25193: [PATCH] Improve the doc of re-search-forward and re-search-backward Hong Xu
2016-12-13 6:27 ` Tino Calancha
2017-04-02 4:42 ` npostavs [this message]
2017-04-02 4:57 ` Tino Calancha
2017-04-02 6:21 ` eliz
2017-04-06 23:19 ` npostavs
2017-04-14 15:12 ` Nicolas Petton
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87o9wfxvvy.fsf@users.sourceforge.net \
--to=npostavs@users.sourceforge.net \
--cc=25193@debbugs.gnu.org \
--cc=hong@topbug.net \
--cc=tino.calancha@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.