Skip to content

API Documentation includes Main in fully qualified names from dependencies #2145

Open
@minestarks

Description

@minestarks

I'm not sure if this is a bug in the documentation generation itself, or in how namespace trees are stored in the HIR / wherever documentation is gathered from.

REPRO

MyProj/src/Main.qs

operation Main() : Unit {
    MyDep.DependencyFunction()
}

MyProj/src/qsharp.json

{
    "dependencies": {
        "MyDep": {
            "path": "../MyDep"
        }
    }
}

MyDep/src/Main.qs

operation DependencyFunction() : Unit {}

export DependencyFunction;

MyDep/src/qsharp.json

{}

Invoke "Show API Documentation" command in VS Code.

Navigate to MyDep > Main.

Expected

Fully qualified name should show up as MyDep.DependencyFunction()

Arguably Main shouldn't even exist as a navigation item, as that namespace is not actually accessible from anywhere in the user project.

Actual

Fully qualified name shows up as MyDep.Main.DependencyFunction

Seen in 3b32013

Metadata

Metadata

Assignees

Labels

bugSomething isn't workinglow-prioritybacklog items with low priority

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions