add the ability to link from the docs to the defining file in the source,
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 25/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Da chiarire
- Stato di attività
- Ferma
- Ambito
- documentation
Direzione di ricerca
Inizia con scribble/private/manual-proc.rkt e esamina il codice nella pull request 229, in particolare il modo in cui defproc identifica le definizioni e i relativi pacchetti. Confronta l’alternativa identifier-binding con drracket/check-syntax e find-def-in-file. Il lavoro sarà completato quando la documentazione generata includerà collegamenti al file sorgente che contiene la definizione e, se viene incluso l’ambito più difficile, alla definizione stessa.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
it was commented recently that linking to source definitions from the documentation to the defining file in GitHub(lab/etc) would be useful. (note finding the definition of an identifier from DrR or RaMo is already available)
a) defproc code will know the defining file, and the code for the section should know the package that the module is in
alternative: use identifier-binding to get the file (‘Linking to the source file is relatively easy, since that information is in the binding’)
NB see code in https://github.com/racket/scribble/pull/229/files
(harder) to add the ability to link from the docs to the DEFINITION in the defining file in the source,
b) find the line/col with drracket/check-syntax or use find-def-in-file
- Lingua principale
- Racket
- Stelle
- 251
- Fork
- 101
- Merge medio
- 6g 22h
- PR unite (30g)
- 1
Preparare l'ambiente
Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di racket/scribble
-
In source strcut*-doc does not convert to defstruct* properly when #:constructor-name is usedAperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 65/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 74/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
-
Difficoltà 3/5 1-2 giorni Idoneità per principianti 55/100
-
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
Tutte le issue di racket/scribble
Issue simili
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
sierra-research/tau2-bench#635 ·
I maintainer di solito rispondono entro 1 giorno
-
The add-ssm-model skill requires a Cython simulator; the contributing guide allows Python onesForse già presa @fmuia l’ha presa oggi. Apertadocumentation skill
Difficoltà 2/5 1-3 ore Idoneità per principianti 83/100
lnccbrown/ssm-simulators#406 ·
I maintainer di solito rispondono entro 4 giorni
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 95/100
btclib-org/btclib-ecc#309 ·
I maintainer di solito rispondono entro 1 giorno
-
area: backends type: docs
Difficoltà 1/5 1-3 ore Idoneità per principianti 83/100
schlessera/brain-kit#2383 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
yunusarda-sudo/arda-suite#15 ·
I maintainer di solito rispondono entro 1 giorno