JuliaDocs/Documenter.jl

Methods in <s>search</s> index results should display signature

Open

#1038 aperta il 13 giu 2019

Vedi su GitHub
 (5 commenti) (3 reazioni) (0 assegnatari)Julia (513 fork)batch import
Format: HTMLTopic: SearchType: Enhancementhelp wanted

Metriche repository

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

Descrizione

If I go to https://nemocas.github.io/AbstractAlgebra.jl/latest/search/?q=modulus then the first four hits are all displayed identically as AbstractAlgebra.Generic.modulus (method).

I have to click on each (or carefully study the link URL) to figure out the difference, and thus ultimately find the correct method.

It would be much nicer if there was extra information about the signature of each method. E.g. instead of (method) one could write (method with signature modulus(a::AbstractAlgebra.PolyElem{T}) where {T <: ResElem}).

Guida contributor

Direzione di ricerca
Esamina la funzionalità di ricerca in Documenter.jl, in particolare il modello HTML che rende i risultati della ricerca. Modificalo per includere le firme dei metodi sfruttando la funzione `methods` di Julia o un'introspezione simile. Guarda come le firme vengono visualizzate nelle pagine di documentazione regolari come riferimento. Il codice rilevante è probabilmente nella directory `src/` relativa alla ricerca o al rendering.
Tech stack
Nessuno
Dominio
documentationdeveloper experience
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.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JuliaDocumenter.jl
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70