JuliaDocs/Documenter.jl

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

Open

#1.038 geöffnet am 13. Juni 2019

Auf GitHub ansehen
 (5 Kommentare) (3 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Format: HTMLTopic: SearchType: Enhancementhelp wanted

Repository-Metriken

Stars
 (910 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

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}).

Contributor Guide

Research-Richtung
Untersuchen Sie die Suchfunktionalität in Documenter.jl, insbesondere die HTML Vorlage, die Suchergebnisse rendert. Ändern Sie sie so, dass Methodensignaturen durch Nutzung von Julias `methods` Funktion oder ähnlicher Introspektion enthalten sind. Sehen Sie sich an, wie Signaturen auf regulären Dokumentationsseiten angezeigt werden, als Referenz. Der relevante Code befindet sich wahrscheinlich im `src/` Verzeichnis im Zusammenhang mit Suche oder Rendering.
Tech Stack
Keine
Domain
documentationdeveloper experience
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-2 Tage
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JuliaDocumenter.jl
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70