JuliaDocs/Documenter.jl

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

Open

#1 038 ouverte le 13 juin 2019

Voir sur GitHub
 (5 commentaires) (3 réactions) (0 assignés)Julia (513 forks)batch import
Format: HTMLTopic: SearchType: Enhancementhelp wanted

Métriques du dépôt

Stars
 (910 stars)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez la fonctionnalité de recherche dans Documenter.jl, en particulier le modèle HTML qui affiche les résultats de recherche. Modifiez le pour inclure les signatures de méthodes en tirant parti de la fonction `methods` de Julia ou d'une introspection similaire. Regardez comment les signatures sont affichées dans les pages de documentation régulières pour référence. Le code pertinent se trouve probablement dans le répertoire `src/` lié à la recherche ou au rendu.
Stack technique
Aucun
Domaine
documentationdeveloper experience
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-2 jours
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JuliaDocumenter.jl
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70