Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
minestarks opened this issue Jan 31, 2025 · 0 comments
Open
Labels
bug Something isn't working needs triage

Comments

@minestarks
Copy link
Member

minestarks commented Jan 31, 2025

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

@minestarks minestarks added bug Something isn't working needs triage labels Jan 31, 2025
@billti billti marked this as a duplicate of #2163 Feb 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working needs triage
Projects
None yet
Development

No branches or pull requests

1 participant