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
property, inherit
The documentation of property-style methods in interfaces should be inherited in the same way that shorthand-syntax methods work.
export interface Bar { /** Some shorthand syntax doc. */ bar(): number; /** Some property style doc. */ baz: () => number; } export class Foo implements Bar { bar(): number { return 0; } baz(): number { return 0; } }
The documentation is attributed to the function type instead of the property and therefore not inherited.
This broke going from version v0.20.37 to v0.21.0.
Doc of Bar:
Bar
Doc of Foo:
Foo
Here is a minimal repo reproducing the bug.
Just run npm ci && npm run docs to generate the docs folder.
npm ci && npm run docs
docs
The text was updated successfully, but these errors were encountered:
I like your bugs :) Very helpful to have an tiny reproduction!
Sorry, something went wrong.
98331b5
No branches or pull requests
Search terms
property, inherit
Expected Behavior
The documentation of property-style methods in interfaces should be inherited in the same way that shorthand-syntax methods work.
Actual Behavior
The documentation is attributed to the function type instead of the property and therefore not inherited.
This broke going from version v0.20.37 to v0.21.0.
Result in v0.20.37
Doc of
Bar
:Doc of
Foo
:Result in v0.21.0
Doc of
Bar
:Doc of
Foo
:Steps to reproduce the bug
Here is a minimal repo reproducing the bug.
Just run
npm ci && npm run docs
to generate thedocs
folder.Environment
The text was updated successfully, but these errors were encountered: