We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
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
The text was updated successfully, but these errors were encountered:
No branches or pull requests
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
MyProj/src/qsharp.json
MyDep/src/Main.qs
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
The text was updated successfully, but these errors were encountered: