JuliaDocs/Documenter.jl

cross-references to docstrings with context

Open

#1 670 ouverte le 10 août 2021

Voir sur GitHub
 (1 commentaire) (0 réactions) (0 assignés)Julia (513 forks)batch import
Type: 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

I can cross-reference to the docstring of the function fun via [`fun`](@ref). In a sentence, the reference may occur as [`fun`](@ref)(`x`). Today I have learned (from @rfourquet) that also [`fun(x)`](@ref) works, which is simpler. However, the hyperlink created by this variant extends over fun(x), whereas the reference is (logically) intended to point to fun. Since Documenter apparently finds out from the string fun(x) that fun is the target in question, wouldn't it make sense to restrict the hyperlink automatically to this substring?

Guide contributeur

Direction de recherche
Inspectez le fonctionnement de l'analyse des références croisées des chaînes de documentation dans Documenter.jl et modifiez la génération des liens pour restreindre automatiquement le lien hypertexte au nom de la fonction dans l'expression entre accents graves.
Stack technique
Aucun
Domaine
documentationtooling
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.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
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