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
No response
enforceExamples: true
@example
With the above configuration, you will get the expected Missing @example tag in ... error message.
Missing @example tag in ...
const a: number = "42"
Docgen should fail with a compilation error on the added @example under the namespace JSDoc.
Docgen succeeds, rendering an invalid TS example.
Either typecheck examples under namespaces, too, or do not enforce examples on namespaces regardless of the configuration.
The text was updated successfully, but these errors were encountered:
fix: typecheck namespace examples (Effect-TS#87)
a752671
Successfully merging a pull request may close this issue.
What version of Effect is running?
No response
What steps can reproduce the bug?
enforceExamples: true
in the config@example
)With the above configuration, you will get the expected
Missing @example tag in ...
error message.@example
to your namespace JSDoc, but make sure it has a compilation error in it, something like:What is the expected behavior?
Docgen should fail with a compilation error on the added
@example
under the namespace JSDoc.What do you see instead?
Docgen succeeds, rendering an invalid TS example.
Additional information
Either typecheck examples under namespaces, too, or do not enforce examples on namespaces regardless of the configuration.
The text was updated successfully, but these errors were encountered: