show php function documentation upon completion
还没有人认领这个 Issue。
评估
- 难度
- 3/5
- 预计耗时
- 1-2 天
- 新手友好度
- 45/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- emacs, emacs-lisp, php
调研方向
首先阅读当前使用 company's annotation 函数的 completion 代码，并将其与 Company's 的 meta 和 doc-buffer 接口进行比较。检查 php-mode's php-search-local-documentation 是否能够为 PHP 函数候选项提供文档，并考虑让 completion 为适用的候选项显示该文档所需的工作。
由索引模型根据 Issue 内容生成。
描述
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 ?)
- 主要语言
- Emacs Lisp
- 星标
- 47
- 派生
- 11
- 平均合并
- 12 分钟
- 30 天内合并 PR
- 1
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
emacs-php/phpactor.el 的其他 Issue
-
难度 3/5 1-2 天 新手友好度 30/100
emacs-php/phpactor.el#161 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 35/100
emacs-php/phpactor.el#153 ·
-
upstream
难度 4/5 3-5 天 新手友好度 35/100
emacs-php/phpactor.el#143 · 2 条评论 ·
-
behind from upstream bug
难度 3/5 1-2 天 新手友好度 25/100
emacs-php/phpactor.el#141 · 4 条评论 · 1 个 reaction ·
-
help wanted
难度 3/5 1-2 天 新手友好度 35/100
emacs-php/phpactor.el#140 ·
查看 emacs-php/phpactor.el 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 77/100
维护者通常 1 天内回复
-
bug good first issue hacktoberfest
难度 2/5 1-3 小时 新手友好度 88/100
codercops/discord-bot#57 ·
维护者通常 1 天内回复
-
uno-testing: the step-by-step procedure serializes tool use (1.7 vs 2.3 tools/call)可能已有人在做 关联的 PR 仍在进行中或已合并。 未关闭
难度 2/5 1-3 小时 新手友好度 67/100
unoplatform/studio#200 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 66/100