JuliaDocs/Documenter.jl

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

Open

#1.038 aberto em 13 de jun. de 2019

Ver no GitHub
 (5 comments) (3 reactions) (0 assignees)Julia (513 forks)batch import
Format: HTMLTopic: SearchType: Enhancementhelp wanted

Métricas do repositório

Stars
 (910 stars)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Examine a funcionalidade de pesquisa no Documenter.jl, especificamente o modelo HTML que renderiza os resultados da pesquisa. Modifique o para incluir assinaturas de métodos aproveitando a função `methods` do Julia ou introspecção similar. Veja como as assinaturas são exibidas nas páginas de documentação regulares para referência. O código relevante provavelmente está no diretório `src/` relacionado à pesquisa ou renderização.
Pilha de tecnologia
None
Domain
documentationdeveloper experience
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-2 dias
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JuliaDocumenter.jl
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70