Documentation comments issues

Abierto
  • ¿Algo no está bien?
#20,646 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 2 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
52/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
fsharp
Área
developer-experience, tooling

Línea de trabajo

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.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
F#
Estrellas
4.3k
Forks
884
Merge medio
2 d 11 h
PR fusionados (30 d)
73

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de dotnet/fsharp

Todos los issues de dotnet/fsharp

Issues similares

Más issues de DevTools

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.