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: convert inline @prop to actual class members #113

Merged
merged 5 commits into from
Sep 28, 2023

Conversation

TTtie
Copy link
Member

@TTtie TTtie commented Sep 24, 2023

This PR aims to aid proper JSDoc generation with correct inheritance by moving away from @prop inline statements at the class declaration down to their respective assignments.

@TTtie TTtie added type: docs Improvements or additions to documentation scope: meta Meta changes labels Sep 24, 2023
@TTtie TTtie added this to the 0.2.0 milestone Sep 24, 2023
@TTtie TTtie self-assigned this Sep 24, 2023
@TTtie TTtie marked this pull request as draft September 24, 2023 22:56
this should introduce proper jsdoc inheritance and make it slightly more convertible
also unifies the cases when the docs would be written directly on the class field
@TTtie TTtie force-pushed the docs/move-at-prop-to-members branch from 7b2db89 to 9e07044 Compare September 26, 2023 22:25
@TTtie TTtie marked this pull request as ready for review September 27, 2023 08:25
@TTtie TTtie merged commit 528695a into dev Sep 28, 2023
2 checks passed
@TTtie TTtie deleted the docs/move-at-prop-to-members branch September 28, 2023 20:44
@TTtie TTtie mentioned this pull request Oct 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: meta Meta changes type: docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant