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

Components: update JSDocs guidelines #34693

Open
1 task
Tracked by #34304
ciampo opened this issue Sep 9, 2021 · 2 comments
Open
1 task
Tracked by #34304

Components: update JSDocs guidelines #34693

ciampo opened this issue Sep 9, 2021 · 2 comments
Labels
[Feature] Component System WordPress component system [Type] Developer Documentation Documentation for developers

Comments

@ciampo
Copy link
Contributor

ciampo commented Sep 9, 2021

What

As discussed in #33960 (comment), the JSDocs guidelines should be updated to acknowledge the TypeScript language and how that affects JSDocs

https://github.com/WordPress/gutenberg/blob/trunk/docs/contributors/code/coding-guidelines.md#javascript-documentation-using-jsdoc

Why

Keeping our docs up to date

A/C

  • Update JSDocs section
@ryanwelcher
Copy link
Contributor

@ciampo is this issue still relevant?

@ciampo
Copy link
Contributor Author

ciampo commented Apr 11, 2023

It is, especially as we refactor more code to TypeScript.

At the minimum, we could acknowledge the usage of TypeScript around the codebase, and that in this case the type information should be removed from the JSDocs as it would be redundant.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Feature] Component System WordPress component system [Type] Developer Documentation Documentation for developers
Projects
None yet
Development

No branches or pull requests

2 participants