emacs-php / emacs-php/phpactor.el

show php function documentation upon completion

Open
#72 2 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Emacs Lisp
Stars
47
Forks
11
PR merge metrics
No merged PRs in 30d

Description

during completion, we rely on phpactor's output to show extra information (such as FQN) for each completion candidate, using company's `annotation` function.

company provides other ways to give contextual help for each candidate. Here's an extract from its source

> meta: The second argument is a completion candidate. Return a (short)
documentation string for it.

> doc-buffer: The second argument is a completion candidate. Return a
buffer with documentation for it. Preferably use `company-doc-buffer'. If
not all buffer contents pertain to this candidate, return a cons of buffer
and window start position.

It would be nice to use php's documentation when completion candidates are php functions (maybe using php-mode's `php-search-local-documentation` function ?)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.