JuliaDocs/Documenter.jl

Allow anchor linking to specific docs of a method

Open

#1.434 aberto em 11 de out. de 2020

Ver no GitHub
 (0 comments) (2 reactions) (0 assignees)Julia (513 forks)batch import
Format: HTMLType: 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

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>

Guia do colaborador

Direção de pesquisa
Investigue como o Documenter.jl gera atualmente as âncoras para assinaturas de funções. Em seguida, modifique a geração de HTML para incluir âncoras únicas para cada método com base na seção e na contagem de métodos.
Pilha de tecnologia
julia
Domain
documentation
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.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Julia
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65