show php function documentation upon completion
まだ誰も着手していません。
評価
- 難易度
- 3/5
- 見積もり時間
- 1〜2日
- 初心者へのやさしさ
- 45/100
- issue の種類
- 機能追加
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- emacs, emacs-lisp, php
調査の方向性
まず、現在 company's の annotation 関数を使用している補完コードを読み、Company's の meta および doc-buffer インターフェースと比較します。php-mode の php-search-local-documentation が PHP 関数の候補にドキュメントを提供できるかを確認し、補完で該当する候補にそのドキュメントを表示するために必要な作業を検討します。
索引モデルが 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分
- マージ済み PR（30日）
- 1
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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 ·
-
rename not workingオープン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 件 ·
-
help wanted
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
emacs-php/phpactor.el#140 ·
emacs-php/phpactor.el の issue をすべて見る
似ている issue
-
Add .gitignore対応中かも @ajeanmahoney が今日担当しました。 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 88/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
nf-core/nf-core-utils#68 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
starkware-libs/sequencer#15229 ·
メンテナーはふだん 1 日以内に返信
-
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
TurboDocx/html-to-docx#253 ·