GNU bug report logs - #56870
company-dabbrev variable documentation

Previous Next

Full log

View this message in rfc822 format

From: uzibalqa <uzibalqa <at> proton.me>
To: Matt Armstrong <matt <at> rfc20.org>
Cc: 56870 <at> debbugs.gnu.org
Subject: bug#56870: company-dabbrev variable documentation
Date: Mon, 01 Aug 2022 21:49:28 +0000

------- Original Message -------
On Monday, August 1st, 2022 at 9:32 PM, uzibalqa <uzibalqa <at> proton.me> wrote:


> ------- Original Message -------
> On Monday, August 1st, 2022 at 9:24 PM, Matt Armstrong matt <at> rfc20.org wrote:
>
>
>
> > uzibalqa uzibalqa <at> proton.me writes:
> >
> > > I am setting company-dabbrev variables
> > >
> > > (setq company-dabbrev-other-buffers 'all)
> > > (setq company-dabbrev-ignore-case 'keep-prefix)
> > >
> > > The documentation for the variables, says
> > >
> > > If ‘all’, search all other buffers, except the ignored ones.
> > >
> > > I find the documentation confusing because nowhere does it say that on
> > > should use 'all rather than all or "all".
> >
> > I can understand your confusion.
> >
> > When working at the level of Emacs Lisp, keep a few things in mind:
> >
> > a) Generally, in Emacs Lisp help, if you see something like ‘all’ it
> > means a lisp level symbol. This could be a function name, variable, or
> > some other symbol. This is part of the project's conventions, described
> > here:
> > https://www.gnu.org/software/emacs/manual/html_node/elisp/Documentation-Tips.html
> >
> > b) When lisp level interfaces expect strings they generally say so, and
> > the examples use quotes like "this".
> >
> > c) A bare all (without any quotes at all), is just a word, and not
> > a Lisp level function or variable.
> >
> > Hope that helps!
>
>
> It is a shame that documentation does not come with example. It is what is much lacking.

Am also having difficulty showing documentation for company-dabbrev-* and company-dabbrev-code-* using `C-h v'.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.