rescript-lang / rescript-lang/rescript-vscode

Would be nice to post process the doc block for links

Aperta
#142 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
ReScript
Stelle
354
Fork
63
Merge medio
11h 29m
PR unite (30g)
1

Descrizione

Low pri.

For a doc block such as:

@ocaml.doc("
  The top level provides some generic sort related utilities.
  It also has two specialized inner modules
  [`Belt.SortArray.Int`](...) and [`Belt.SortArray.String`](...)
")

it'd be nice to postprocess those links so that they're clickable. The IDE supports that. Caveat: doesn't support jumping to a line, so most of the links will be useless for now.

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia con l’esempio del blocco @ocaml.doc e segui come vengono gestiti il testo della documentazione e i relativi link nel plugin VSCode. Confronta i link cliccabili desiderati con il comportamento dell’IDE descritto nell’issue, quindi verifica che i link supportati diventino cliccabili senza implicare una navigazione a una riga.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
vscode
Ambito
developer-experience, tooling
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
30/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.