Skip to content

Document attributes#145

Merged
MattiasBuelens merged 11 commits intomainfrom
document-attributes
Apr 29, 2026
Merged

Document attributes#145
MattiasBuelens merged 11 commits intomainfrom
document-attributes

Conversation

@MattiasBuelens
Copy link
Copy Markdown
Collaborator

We now re-use the documentation of class properties (with a @property decorator) for the associated attribute. This way, we no longer need a separate @attribute tag in the component's documentation.

@MattiasBuelens MattiasBuelens added the documentation Improvements or additions to documentation label Apr 28, 2026
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 28, 2026

⚠️ No Changeset found

Latest commit: 9e58bc2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

*/
export function load(app: typedoc.Application) {
app.converter.on(typedoc.Converter.EVENT_CREATE_DECLARATION, onDeclaration);
app.converter.on(typedoc.Converter.EVENT_CREATE_SIGNATURE, onSignature);
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Turns out this was just going through the same reflections as onDeclaration, resulting in duplicate documentation. 😅

@MattiasBuelens MattiasBuelens merged commit c3584af into main Apr 29, 2026
1 check passed
@MattiasBuelens MattiasBuelens deleted the document-attributes branch April 29, 2026 07:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants