Documentation comments issues

Aperta
  • Qualcosa non va?
#20,646 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
52/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
fsharp
Ambito
developer-experience, tooling

Direzione di ricerca

Start with the Oxpecker repository's examples/Basic/Program.fs at line 136 and reproduce the issue by hovering over the referenced code on the main branch. Investigate how F# documentation comments are surfaced for a type with a primary constructor and for a property from a transitively referenced NuGet package. Done means both comments appear, including when the package is only referenced transitively.

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

Descrizione

Bug Needs-Triage

I've recently extended Oxpecker.ViewEngine package documentation, but found that it doesn't work as expected. I've found two issues for the following definition:

/// Embeds or references a script or data block.
type script() =
    inherit RegularNode("script")
    /// URL of the media, image, script, or embedded resource.
    member this.src
        with set (value: string | null) = this.attr("src", value) |> ignore
  1. Documentation over type with primary constructor script is not shown
Image
  1. Documentation over property src is not shown when nuget package is referenced transitively (this was actually tricky to find)
Image

Repro steps

  1. Go to Oxpecker repository, download sources from the main branch.
  2. Open the solution, hover over this line

Second issue is not visible on develop branch (since projects are referenced directly) or if Oxpecker.ViewEngine dependency is added directly (as opposed to transitively)

Expected behavior

I see documentation comments in both cases

Actual behavior

I don't see documentation comments in both cases

Known workarounds

For the second issue, reference Oxpecker.ViewEngine package directly. There is no workaround for the first issue.

Related information

.NET SDK 11.0.0-rc.1.26425.128

Lingua principale
F#
Stelle
4.3k
Fork
884
Merge medio
2g 11h
PR unite (30g)
73

Preparare l'ambiente

Apri in Codespaces

Avvia il container di sviluppo del progetto nel browser, con il tuo account GitHub.

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.

Altre issue di dotnet/fsharp

Tutte le issue di dotnet/fsharp

Issue simili

Altre issue su DevTools

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.