JuliaDocs/Documenter.jl

Allow anchor linking to specific docs of a method

Open

#1434 aperta il 11 ott 2020

Vedi su GitHub
 (0 commenti) (2 reazioni) (0 assegnatari)Julia (513 fork)batch import
Format: HTMLType: Enhancementhelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

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>

Guida contributor

Direzione di ricerca
Studia come Documenter.jl genera attualmente gli ancoraggi per le firme delle funzioni. Poi modifica la generazione HTML per includere ancoraggi unici per ogni metodo basati sulla sezione e sul conteggio dei metodi.
Tech stack
julia
Dominio
documentation
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Julia
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65