JuliaDocs/Documenter.jl

Allow anchor linking to specific docs of a method

Open

#1 434 ouverte le 11 oct. 2020

Voir sur GitHub
 (0 commentaires) (2 réactions) (0 assignés)Julia (513 forks)batch import
Format: HTMLType: 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

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>

Guide contributeur

Direction de recherche
Examinez comment Documenter.jl génère actuellement les ancres pour les signatures de fonctions. Modifiez ensuite la génération HTML pour inclure des ancres uniques pour chaque méthode en fonction de la section et du nombre de méthodes.
Stack technique
julia
Domaine
documentation
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.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Julia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
65