JuliaDocs/Documenter.jl

Allow anchor linking to specific docs of a method

Open

#1,434 opened on 2020年10月11日

GitHub で見る
 (0 comments) (2 reactions) (0 assignees)Julia (513 forks)batch import
Format: HTMLType: Enhancementhelp wanted

Repository metrics

Stars
 (910 stars)
PR merge metrics
 (平均マージ 16d 9h) (30d で 3 merged PRs)

説明

For example, addprocs (Distributed Computing) has a lot of different methods. It would be nice if we could link to a specific one directly via an HTML anchor.

The anchors could looke like (for addprocs):

  • #Distributed-Computing-addprocs-1
  • #Distributed-Computing-addprocs-2
  • #Distributed-Computing-addprocs-3

or, more generically:

  • #<section>-<methodname>-<count>

コントリビューターガイド

調査方針
現在のDocumenter.jlが関数シグネチャのアンカーをどのように生成しているかを調査します。次に、セクションとメソッド数に基づいて各メソッドに一意のアンカーを追加するようにHTML生成を変更します。
技術スタック
julia
領域
documentation
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
新着
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Julia
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
65