search

WordPress / gutenberg

The Block Editor project for WordPress and beyond. Plugin is available from the official repository.
https://wordpress.org/gutenberg/
Other
10.52k stars 4.21k forks source link

Components: update JSDocs guidelines #34693

Open ciampo opened 3 years ago

ciampo commented 3 years ago

What

As discussed in https://github.com/WordPress/gutenberg/pull/33960#discussion_r704632262, 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

ryanwelcher commented 1 year ago

@ciampo is this issue still relevant?

ciampo commented 1 year ago

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.