<see langword="..."/> renders as nothing in API docs
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 78/100
- Tipo di issue
- Bug
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Attiva
- Stack tecnologico
- fsharp
- Ambito
- documentation
Direzione di ricerca
Inizia dalla gestione di see e seealso in src/FSharp.Formatting.ApiDocs/XmlDocReader.fs, alle righe 193–213. Verifica come il lettore gestisce cref e come gli elementi c diventano codice in linea, poi segui i test pertinenti della documentazione API. Il lavoro è completo quando valori langword come true vengono visualizzati come codice in linea invece di scomparire.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
XmlDocReader renders a <see> or <seealso> element only when it has a cref attribute (XmlDocReader.fs#L193-L213). <see langword="true"/>, the .NET way to reference a keyword, has no cref, so the word is lost: /// <summary>Returns <see langword="true"/> when the event has at least one handler.</summary> renders as "Returns when the event has at least one handler." The expected output is the keyword as inline code, the same as <c>true</c>.
FSharp.Core starts to use langword in dotnet/fsharp#20940, so its API reference shows the gap.
- Lingua principale
- F#
- Stelle
- 492
- Fork
- 160
- Merge medio
- 3g 14h
- PR unite (30g)
- 6
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
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 fsprojects/FSharp.Formatting
-
enhancement help wanted
Difficoltà 5/5 Più di una settimana Idoneità per principianti 25/100
fsprojects/FSharp.Formatting#1064 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
fsprojects/FSharp.Formatting#929 · 8 commenti · 13 reazioni ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 48/100
fsprojects/FSharp.Formatting#928 · 18 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Nesting Document CategoriesForse di nuovo libera Una pull request per questa issue è stata chiusa senza essere unita. Apertaenhancement needs-community-interest
Difficoltà 5/5 Più di una settimana Idoneità per principianti 35/100
fsprojects/FSharp.Formatting#927 · 7 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
enhancement
Difficoltà 4/5 3-5 giorni Idoneità per principianti 35/100
fsprojects/FSharp.Formatting#898 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di fsprojects/FSharp.Formatting
Issue simili
-
documentation good first issue
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 88/100
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 84/100
MarketSquare/robotframework-browser#5479 ·
I maintainer di solito rispondono entro 1 giorno
-
documentation review-2.0.0
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
dkuenzel/meshcore-home-gateway#106 ·
I maintainer di solito rispondono entro 1 giorno
-
bug
Difficoltà 1/5 1-3 ore Idoneità per principianti 83/100
chanzuckerberg/cellxgene-census#1468 ·
-
status: needs triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
mastra-ai/mastra#29641 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno