Skip to content

Documentation comments issues #20646

Description

@Lanayx

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

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    Projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions