JuliaDocs/Documenter.jl

cross-references to docstrings with context

Open

#1.670 geöffnet am 10. Aug. 2021

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Julia (513 Forks)batch import
Type: Enhancementhelp wanted

Repository-Metriken

Stars
 (910 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 16T 9h) (3 gemergte PRs in 30 T)

Beschreibung

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?

Contributor Guide

Research-Richtung
Untersuchen Sie, wie Documenter.jl die Cross Reference Parsing von Docstrings durchführt, und modifizieren Sie die Linkgenerierung, um den Hyperlink automatisch auf den Funktionsnamen innerhalb des Backtick Ausdrucks zu beschränken.
Tech Stack
Keine
Domain
documentationtooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JuliaDocumenter.jl
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70