From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Stefan Kangas Newsgroups: gmane.emacs.bugs Subject: bug#24607: 25.1; comment-dwim doc is confused Date: Tue, 11 Aug 2020 18:06:44 -0700 Message-ID: References: <201610041140493910850@yahoo.com> <87zi4c8d7m.fsf@users.sourceforge.net> Mime-Version: 1.0 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="29432"; mail-complaints-to="usenet@ciao.gmane.io" User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/28.0.50 (gnu/linux) Cc: "liu.huanjie@yahoo.com" , 24607@debbugs.gnu.org To: Noam Postavsky Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Aug 12 03:08:37 2020 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1k5fFs-0007Zl-N9 for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 12 Aug 2020 03:08:36 +0200 Original-Received: from localhost ([::1]:44048 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1k5fFr-0006vz-Oe for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 11 Aug 2020 21:08:35 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:60572) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1k5fFK-0006Ng-FQ for bug-gnu-emacs@gnu.org; Tue, 11 Aug 2020 21:08:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:58856) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1k5fFK-0001Tt-50 for bug-gnu-emacs@gnu.org; Tue, 11 Aug 2020 21:08:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1k5fFJ-0001AX-QT for bug-gnu-emacs@gnu.org; Tue, 11 Aug 2020 21:08:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Stefan Kangas Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 12 Aug 2020 01:08:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 24607 X-GNU-PR-Package: emacs Original-Received: via spool by 24607-submit@debbugs.gnu.org id=B24607.15971944234396 (code B ref 24607); Wed, 12 Aug 2020 01:08:01 +0000 Original-Received: (at 24607) by debbugs.gnu.org; 12 Aug 2020 01:07:03 +0000 Original-Received: from localhost ([127.0.0.1]:42164 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1k5fEN-00018k-D2 for submit@debbugs.gnu.org; Tue, 11 Aug 2020 21:07:03 -0400 Original-Received: from mail-yb1-f195.google.com ([209.85.219.195]:42205) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1k5fEA-00017r-OZ for 24607@debbugs.gnu.org; Tue, 11 Aug 2020 21:06:51 -0400 Original-Received: by mail-yb1-f195.google.com with SMTP id a34so450292ybj.9 for <24607@debbugs.gnu.org>; Tue, 11 Aug 2020 18:06:50 -0700 (PDT) X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:in-reply-to:references:user-agent :mime-version:date:message-id:subject:to:cc :content-transfer-encoding; bh=OqzJDwGFjo84NeCRgF/XWe+ObQ16AOC3NQzPm7hI0as=; b=grQCcygvCfQhbxAp1yKEjImspZpX8b3ZaeRttnhNdkprEbdjG369Z1Lb9H4jUI++VP IdE8GRmpdfuc9f9Jmj2mMmeLwrb4jK6LZvO/n0ftVsGuwmgM+pZ8Sxe2LGSFzlThewbs OEcOQvRUc/6VpArJoSv3Xutp1LUdhA4UlNajeNSxg5gxjqr3sfG099bg0w6Vgh5DR80z bx/9FEpaRENJ02QH+SLJincnCt2NWMxVuwn3WJzRr0tUcmOXgy3qRGkiXVXuAShlpldG EtHXoxTQP/mbC5pLA1FKEh+kgaCzH/jgfMMTQQNo30AGiNaELlA5ktS16tIaZW0BDw3o BprQ== X-Gm-Message-State: AOAM532yjs/ywo6+FR3MaVuRHZjcgGVJ4djARDXxsicBFTU4usrTbdBM OGCfZAG77KP/PN/8S3rJO8lJswSSBoTfLNrK7z9dfkvNEgY= X-Google-Smtp-Source: ABdhPJw4HiZnMoiXxzqrpguND+T5r+vQo4C0VdrdMycq0DIVWagUf9LUsJxVjRzTcR05U0OscJqnKoHld8S3gsA0tLY= X-Received: by 2002:a25:b290:: with SMTP id k16mr21238762ybj.389.1597194405389; Tue, 11 Aug 2020 18:06:45 -0700 (PDT) Original-Received: from 753933720722 named unknown by gmailapi.google.com with HTTPREST; Tue, 11 Aug 2020 18:06:44 -0700 In-Reply-To: <87zi4c8d7m.fsf@users.sourceforge.net> (Noam Postavsky's message of "Tue, 13 Feb 2018 22:25:17 -0500") X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list 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-mx.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.io gmane.emacs.bugs:184710 Archived-At: tags 24607 + wontfix notabug close 24607 thanks Noam Postavsky writes: > "liu.huanjie@yahoo.com" writes: > >> Today I try to write a function that call comment-dwim, it works >> when I 'M-x comment-dwim', but when I call it as (comment-dwim), it >> says wrong argument number, but after checking the doc and read the >> source, I still can't figure out how to give args, which what I want >> is the current line where my cursor is. >> I add 'nil' to 'comment-dwim' and fixed, but it will be better to >> add something about what args should a caller give, and that will >> not confused to at least elisp newbie, and it is better. > > The docstring says > > (comment-dwim ARG) > > [...] > Else if a prefix ARG is specified, call =E2=80=98comment-kill=E2=80= =99. > > It's a bit terse, but `(elisp) Prefix Command Arguments' says > > * `nil', meaning there is no prefix argument. > > as a possible value for prefix arguments. I don't think we should > explain that again in every function docstring which takes a prefix > argument. I agree with Noam here, we shouldn't repeat this information in every function that takes a prefix argument. I'm therefore closing this bug report. Best regards, Stefan Kangas