Skip to content
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

[docs/api] Directives documentations start with the ancestor class' description. #1289

Open
Totati opened this issue Jan 10, 2024 · 1 comment

Comments

@Totati
Copy link
Contributor

Totati commented Jan 10, 2024

Directives which extend Directive class has the same

Base class for creating custom directives. Users should extend this class, implement render and/or update, and then pass their subclass to directive.

description.

Directives which extend AsyncDirective class has the same

An abstract Directive base class whose disconnected method will be called when the part containing the directive is cleared as a result of re-rendering, or when the user calls part.setConnected(false) on a part that was previously rendered containing the directive (as happens when e.g. a LitElement disconnects from the DOM).

description

Directives page

@augustjk augustjk moved this to 📋 Triaged in Lit Project Board Jan 11, 2024
@augustjk
Copy link
Member

Ah.. thanks for the report.

Looks like these might be caused by the export of the directive implementation classes, but since the classes themselves don't have jsdoc, they somehow go all the way down to the base class that does have jsdoc?

Listing all the class API of the directive implementations seems of dubious value since it's really just the directive that is meant to be pubic facing and used. I believe the class or the type of it is exported only to allow typescript to resolve the return type of the directive call. Perhaps this was always the intention too, as the table of contents of the directives API page never list those classes either.

We probably want to just filter those out during API doc generation.

@augustjk augustjk changed the title Directives documentations start with the ancestor class' description. [docs/api] Directives documentations start with the ancestor class' description. Jan 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 📋 Triaged
Development

No branches or pull requests

2 participants