Skip to content

API Documentation doesn't show up if there's an error in a dependency #2144

Closed
@minestarks

Description

@minestarks

Today, the "Show API documentation" works even when there are errors in the current project. This is good.

However, if there are errors in a dependency, the "Show API documentation" shows a blank page.

REPRO

MyProj/src/Main.qs

operation Main() : Unit {
    WillCauseCompilerError; // This error doesn't block documentation generation ✅
}

MyProj/src/qsharp.json

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

MyDep/src/Main.qs

operation DependencyFunction() : Unit {
    WillCauseCompilerError; // This blocks documentation generation! ❌
}

export DependencyFunction;

MyDep/src/qsharp.json

{}

Invoke "Show API Documentation" command in VS Code.

Expected

The documentation should still be generated for whatever did compile.

Nice to have: To avoid confusion, the documentation panel should also show any compiler errors that were in the project.

Actual

Blank documentation page.

Seen in 3b32013

Metadata

Metadata

Assignees

Labels

bugSomething isn't working

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions