From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Robert Weiner Newsgroups: gmane.emacs.bugs Subject: bug#23623: Patch to improve function options in find-func.el Date: Mon, 18 Dec 2017 11:24:44 -0500 Message-ID: References: <87o9oe6gt1.fsf@users.sourceforge.net> <83vah4ow8z.fsf@gnu.org> Reply-To: rswgnu@gmail.com NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="089e0828a8fc9566fd05609fcb6a" X-Trace: blaine.gmane.org 1513614256 465 195.159.176.226 (18 Dec 2017 16:24:16 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 18 Dec 2017 16:24:16 +0000 (UTC) Cc: Noam Postavsky , 23623@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Dec 18 17:24:12 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 1eQyD5-0008Ad-Jm for geb-bug-gnu-emacs@m.gmane.org; Mon, 18 Dec 2017 17:24:11 +0100 Original-Received: from localhost ([::1]:53619 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eQyF3-0004N0-Ja for geb-bug-gnu-emacs@m.gmane.org; Mon, 18 Dec 2017 11:26:13 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51864) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eQyEw-0004ML-6G for bug-gnu-emacs@gnu.org; Mon, 18 Dec 2017 11:26:07 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eQyEs-00052C-6Q for bug-gnu-emacs@gnu.org; Mon, 18 Dec 2017 11:26:06 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:60309) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eQyEs-00051f-2g for bug-gnu-emacs@gnu.org; Mon, 18 Dec 2017 11:26:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eQyEr-0003Ub-RW for bug-gnu-emacs@gnu.org; Mon, 18 Dec 2017 11:26:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Robert Weiner Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 18 Dec 2017 16:26:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 23623 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 23623-submit@debbugs.gnu.org id=B23623.151361432713384 (code B ref 23623); Mon, 18 Dec 2017 16:26:01 +0000 Original-Received: (at 23623) by debbugs.gnu.org; 18 Dec 2017 16:25:27 +0000 Original-Received: from localhost ([127.0.0.1]:40757 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eQyEJ-0003To-Hg for submit@debbugs.gnu.org; Mon, 18 Dec 2017 11:25:27 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:59780) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eQyEI-0003Tb-Ej for 23623@debbugs.gnu.org; Mon, 18 Dec 2017 11:25:26 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eQyE8-0004PW-2h for 23623@debbugs.gnu.org; Mon, 18 Dec 2017 11:25:21 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:39817) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eQyE7-0004PG-VN for 23623@debbugs.gnu.org; Mon, 18 Dec 2017 11:25:16 -0500 Original-Received: from mail-qt0-f179.google.com ([209.85.216.179]:38334) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_128_CBC_SHA1:128) (Exim 4.82) (envelope-from ) id 1eQyE7-00038q-KV for 23623@debbugs.gnu.org; Mon, 18 Dec 2017 11:25:15 -0500 Original-Received: by mail-qt0-f179.google.com with SMTP id d4so20676094qtj.5 for <23623@debbugs.gnu.org>; Mon, 18 Dec 2017 08:25:15 -0800 (PST) X-Gm-Message-State: AKGB3mKwuZYzXJdHVyDj+zHed1NgaKmKliIpH8TQIvppog62hGNP/6Xk bOtLyXKwj3l8B9wmWy5iAGCO6ZxLdCWeQdC6J0Q= X-Google-Smtp-Source: ACJfBovUDWqzSJ0Lpizzb1YW1VvaWpc/F13VvHmqruj5auaN1SvENRM5ueA9pvA9XNu3F8ABb6xA+ZActJ09mg+MJak= X-Received: by 10.200.19.11 with SMTP id e11mr355287qtj.62.1513614315184; Mon, 18 Dec 2017 08:25:15 -0800 (PST) Original-Received: by 10.200.55.124 with HTTP; Mon, 18 Dec 2017 08:24:44 -0800 (PST) In-Reply-To: <83vah4ow8z.fsf@gnu.org> X-Gmail-Original-Message-ID: X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] 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:141221 Archived-At: --089e0828a8fc9566fd05609fcb6a Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable On Mon, Dec 18, 2017 at 11:07 AM, Eli Zaretskii wrote: > > From: Robert Weiner > > Date: Sun, 17 Dec 2017 23:33:04 -0500 > > Cc: 23623@debbugs.gnu.org > > > > =E2=80=8B=E2=80=8B=E2=80=8BI have made this requested change and herein= attach the patch. I hope > > you can integrate it sometime. > > Thanks. I have a few minor comments: > =E2=80=8BThanks for the feedback. I'll work on it. I often find that I have to make the first line of docstrings long when it involves 3 or more arguments. Is it preferable in such cases where the text cannot be shortened enough to discuss only some of the arguments on the first line and document the rest afterwards? Bob --089e0828a8fc9566fd05609fcb6a Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
On Mon, Dec 18, 2= 017 at 11:07 AM, Eli Zaretskii <e= liz@gnu.org> wro= te:
<= blockquote class=3D"gmail_quote" style=3D"margin:0 0 0 .8ex;border-left:1px= #ccc solid;padding-left:1ex">> From: Robert Weiner <rsw@gnu.org>
> Date: Sun, 17 Dec 2017 23:33:04 -0500
> Cc: 23623@debbugs.gnu.org=
>
> =E2=80=8B=E2=80=8B=E2=80=8BI have made this requested change and herei= n attach the patch.=C2=A0 I hope
> you can integrate it sometime.

Thanks.=C2=A0 I have a few minor comments:

=
=E2=80=8BThanks for the feedback.=C2=A0 I'll work on it.=C2=A0 I ofte= n find
that I have to make the first line of docstrings long
when it invo= lves 3 or more arguments.=C2=A0 Is it preferable
in such cases where the t= ext cannot be shortened enough
to discuss only some of the arguments on th= e first line
and document the rest afterwards?

Bob

--089e0828a8fc9566fd05609fcb6a--