From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: YE via "Bug reports for GNU Emacs, the Swiss army knife of text editors" Newsgroups: gmane.emacs.bugs Subject: bug#56870: company-dabbrev variable documentation Date: Wed, 03 Aug 2022 13:07:02 +0300 Message-ID: References: <878ro74pz5.fsf@rfc20.org> <87y1w7ymiu.fsf@gnus.org> Reply-To: YE 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="7906"; mail-complaints-to="usenet@ciao.gmane.io" Cc: Matt Armstrong , uzibalqa , 56870@debbugs.gnu.org To: Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Wed Aug 03 12:17:35 2022 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 1oJBRW-0001sG-PV for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 03 Aug 2022 12:17:35 +0200 Original-Received: from localhost ([::1]:49796 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1oJBRU-0001dV-60 for geb-bug-gnu-emacs@m.gmane-mx.org; Wed, 03 Aug 2022 06:17:33 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:34760) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1oJBII-0007po-Of for bug-gnu-emacs@gnu.org; Wed, 03 Aug 2022 06:08:02 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:56439) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1oJBII-0005kQ-FS for bug-gnu-emacs@gnu.org; Wed, 03 Aug 2022 06:08:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1oJBII-0003ke-C7 for bug-gnu-emacs@gnu.org; Wed, 03 Aug 2022 06:08:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: YE Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 03 Aug 2022 10:08:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 56870 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: notabug Original-Received: via spool by 56870-submit@debbugs.gnu.org id=B56870.165952123014305 (code B ref 56870); Wed, 03 Aug 2022 10:08:02 +0000 Original-Received: (at 56870) by debbugs.gnu.org; 3 Aug 2022 10:07:10 +0000 Original-Received: from localhost ([127.0.0.1]:46182 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oJBHR-0003ie-Tp for submit@debbugs.gnu.org; Wed, 03 Aug 2022 06:07:10 -0400 Original-Received: from out2.migadu.com ([188.165.223.204]:56876) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1oJBHO-0003iS-JZ for 56870@debbugs.gnu.org; Wed, 03 Aug 2022 06:07:09 -0400 X-Report-Abuse: Please report any abuse attempt to abuse@migadu.com and include these headers. DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=ego.team; s=key1; t=1659521225; h=from:from:reply-to:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type: content-transfer-encoding:content-transfer-encoding: in-reply-to:in-reply-to:references:references; bh=LK8MevfNhiXnxd/YiSJ/iuqsZP2WSE4DcI25XrLwF2U=; b=VNcAq7zsL+lnSf1HkLIOXVbRc6UPoJuQratxhcq0NJE0cXDeHeQmeMn5SRibaUoC8PxBux y0qLE2FyohtTIUW9Ajo2xiyqLUuFJheqDKkdVaVi+ZDeceZ+DlgzbF79/wQDkNnr9TO7pD /QRtqUAmbhhnJDTyxI0j1qWFS45BMMo= In-Reply-To: <87y1w7ymiu.fsf@gnus.org> (Lars Ingebrigtsen's message of "Tue, 02 Aug 2022 12:20:41 +0200") X-Migadu-Flow: FLOW_OUT X-Migadu-Auth-User: ego.team 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" X-ACL-Warn: , YE Xref: news.gmane.io gmane.emacs.bugs:238629 Archived-At: > So I don't think there's anything to fix in Emacs here -- we sometimes > say "the symbol `all'" if there's an unusual amount of possible > confusion present -- and I'm therefore closing this bug report. I'd still suggest considering documentation improvement in this regard. Probably because I had the same confusion when started with Emacs, even after having read the whole manual. [Well, the info node `(elisp) Documentation Tips)' clarifies how to document symbols : > When a documentation string refers to a Lisp symbol, write it as it > would be printed (which usually means in lower case), surrounding > it with curved single quotes (=E2=80=98..=E2=80=99) But Emacs beginner users don't seem to be the target auditory of this page. And it still won't -- naturally -- explain how to _use_ such symbols.] One such possible place to adjust is the info node `(emacs) Examining'. Maybe replace 'fill-column' example with the one that accepts a documented symbol (f.i. 'default-justification', 'diff-refine', 'tab-always-complete') and use the symbol in the code below? Another: info node `(emacs) Init Syntax' could probably state more explicitly how to deal with the symbols. Or mention symbols documentation/usage at the end of the info node `(emacs) Variables', after the line "check the variable=E2=80=99s documenta= tion string to see what kind of value it expects". WDYT?