Check/find/locate the customized function/command of a specific project in Emacs conveniently/quickly/efficiently.

Check/find/locate the customized function/command of a specific project in Emacs conveniently/quickly/efficiently.

[Hongyi Zhao]

I'm currently learning the configuration used by doom Emacs [1]. For
example, the following code snippet shows on
<https://github.com/hlissner/doom-emacs/blob/2731685095d1e6101b3215aa689426e1834ce00f/modules/lang/latex/config.el#L256>:

(use-package! company-math
:when (featurep! :completion company)
:defer t
:init
(add-to-list '+latex--company-backends
#'+latex-symbols-company-backend nil #'eq))

In the above code snippet, there are some customized
function/command/variable, i.e., use-package!, featurep!,
+latex--company-backends, and +latex-symbols-company-backend, which
are not so easy to understand just by their names. So, I want to
check/find/locate the corresponding definitions for them in Emacs
conveniently/quickly/efficiently. Because they are customized things,
the
`M-.' doesn't work for them.

Any hints for this question will be highly appreciated?

[1] https://github.com/hlissner/doom-emacs

Regards
-- 
Assoc. Prof. Hongyi Zhao <hongyi.zhao@gmail.com>
Theory and Simulation of Materials
Hebei Vocational University of Technology and Engineering
NO. 552 North Gangtie Road, Xingtai, China

Re: Check/find/locate the customized function/command of a specific project in Emacs conveniently/quickly/efficiently.

[Daniel Martín]

Hongyi Zhao <hongyi.zhao@gmail.com> writes:

> I'm currently learning the configuration used by doom Emacs [1]. For
> example, the following code snippet shows on
> <https://github.com/hlissner/doom-emacs/blob/2731685095d1e6101b3215aa689426e1834ce00f/modules/lang/latex/config.el#L256>:
>
> (use-package! company-math
> :when (featurep! :completion company)
> :defer t
> :init
> (add-to-list '+latex--company-backends
> #'+latex-symbols-company-backend nil #'eq))
>
> In the above code snippet, there are some customized
> function/command/variable, i.e., use-package!, featurep!,
> +latex--company-backends, and +latex-symbols-company-backend, which
> are not so easy to understand just by their names. So, I want to
> check/find/locate the corresponding definitions for them in Emacs
> conveniently/quickly/efficiently. Because they are customized things,
> the
> `M-.' doesn't work for them.

It seems like use-package! is a macro defined by Doom Emacs, so you can
do C-h f use-package! RET to read its documentation.  Similarly,
+latex-symbols-company-backend seems like a Lisp variable added by Doom
Emacs, so you can get help by doing C-h v +latex-symbols-company-backend
RET.

Alternatively, you can type C-h o (describe-symbol) to get documentation
about any symbol (variable, function, etc.).

Re: Check/find/locate the customized function/command of a specific project in Emacs conveniently/quickly/efficiently.

[Hongyi Zhao]

On Mon, Jul 5, 2021 at 5:22 AM Daniel Martín <mardani29@yahoo.es> wrote:
>
> Hongyi Zhao <hongyi.zhao@gmail.com> writes:
>
> > I'm currently learning the configuration used by doom Emacs [1]. For
> > example, the following code snippet shows on
> > <https://github.com/hlissner/doom-emacs/blob/2731685095d1e6101b3215aa689426e1834ce00f/modules/lang/latex/config.el#L256>:
> >
> > (use-package! company-math
> > :when (featurep! :completion company)
> > :defer t
> > :init
> > (add-to-list '+latex--company-backends
> > #'+latex-symbols-company-backend nil #'eq))
> >
> > In the above code snippet, there are some customized
> > function/command/variable, i.e., use-package!, featurep!,
> > +latex--company-backends, and +latex-symbols-company-backend, which
> > are not so easy to understand just by their names. So, I want to
> > check/find/locate the corresponding definitions for them in Emacs
> > conveniently/quickly/efficiently. Because they are customized things,
> > the
> > `M-.' doesn't work for them.
>
> It seems like use-package! is a macro defined by Doom Emacs, so you can
> do C-h f use-package! RET to read its documentation.  Similarly,
> +latex-symbols-company-backend seems like a Lisp variable added by Doom
> Emacs, so you can get help by doing C-h v +latex-symbols-company-backend
> RET.
>
> Alternatively, you can type C-h o (describe-symbol) to get documentation
> about any symbol (variable, function, etc.).

To use the above method, I must have installed Doom Emacs, but that's
not the case on my side - I just want to inspect Doom Emacs'
configurations source code for learning some mechanisms developed by
it.

Regards
-- 
Assoc. Prof. Hongyi Zhao <hongyi.zhao@gmail.com>
Theory and Simulation of Materials
Hebei Vocational University of Technology and Engineering
NO. 552 North Gangtie Road, Xingtai, China

Re: Check/find/locate the customized function/command of a specific project in Emacs conveniently/quickly/efficiently.

[Daniel Martín]

Hongyi Zhao <hongyi.zhao@gmail.com> writes:
>>
>> It seems like use-package! is a macro defined by Doom Emacs, so you can
>> do C-h f use-package! RET to read its documentation.  Similarly,
>> +latex-symbols-company-backend seems like a Lisp variable added by Doom
>> Emacs, so you can get help by doing C-h v +latex-symbols-company-backend
>> RET.
>>
>> Alternatively, you can type C-h o (describe-symbol) to get documentation
>> about any symbol (variable, function, etc.).
>
> To use the above method, I must have installed Doom Emacs, but that's
> not the case on my side - I just want to inspect Doom Emacs'
> configurations source code for learning some mechanisms developed by
> it.

In that case, as the ELisp code is not part of the environment, you
could try any of the following features:

- Create a TAGS file for the files in the Doom project.  Read (info
  "(emacs) Tags Tables") for more information.

- M-x grep or M-x rgrep to use grep or a similar tool to search for
  a regular expression.

- If you want something a bit more sophisticated that understands ELisp
  better, you could try the ELPA package el-search
  (https://elpa.gnu.org/packages/el-search.html).