google / google/codeworld

Link to a complete source from doc popups

オープン
#816 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

enhancement
主要言語
Haskell
スター
1.3k
フォーク
201
PR マージ指標
30日以内にマージされた PR はありません

説明

The doc window in autocomplete and doc-on-hover has the first part of the documentation for a symbol, but it's often cut off. Ideally, it would contain a link to the full documentation. For built-in symbols, this link could open the guide to the generated haddock for the symbol (this requires understanding haddock's anchor format...). For symbols defined in the code, it could act like a go-to-definition feature.

(For doc-on-hover, this implies making a change so that it's possible to click on the doc window at all. The obvious candidate here is to make the doc location "stickier", so that once it opens, it remains in the same place even when the mouse moves, so long as the mouse is over the same symbol, or is hovering over the doc window.)

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、autocomplete と doc-on-hover で使用されるドキュメントウィンドウを追跡します。組み込みシンボルが生成された Haddock ドキュメントをどのように公開するか、またコードで定義されたシンボルがナビゲーションをどのようにサポートするかを確認し、Haddock のアンカー形式とホバーウィンドウの動作を調べます。完了の条件は、ポップアップが完全なドキュメントまたは定義への使用可能なリンクを提供し、doc-on-hover が引き続きクリック可能であることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
haskell
領域
developer-experience, documentation, frontend
issue の種類
機能追加
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
30/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。