Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
Docs: Add Gutenberg-specific JSDoc recommendations #18920
There's a few things I chose not to include here, though might be relevant for additional detailing:
As these changes only include edits to documentation, there is no expected impact on the application runtime.
@dsifford Good call. I think subconsciously the
I agree it's probably best to be consistent here. I'd probably lean toward the single quote. What do you think?
gziolo left a comment •
I had some minor comments but overall I love the proposal. I don't know what are the next steps planned, but I would be fine with merging it as soon as possible. We should follow the guidelines while enabling TypeScript validation for packages and revisit all proposals once we encounter any issues in the actual usage.
* Docs: Add Gutenberg-specific JSDoc recommendations * Docs: JSDoc Guidelines: Include section "Nullable, Undefined, and Void Types" * Docs: JSDoc Guidelines: Simply phrasing around function components * Docs: JSDoc Guidelines: Include example key of named string set * Docs: JSDoc Guidelines: Use single quote for string literal set * Docs: JSDoc: Prescribe use of single quotes * Docs: JSDoc: Simplify language around exposing types * Docs: JSDoc: Use "entry point" instead of "entrypoint" Co-Authored-By: Grzegorz (Greg) Ziółkowski <firstname.lastname@example.org> * Docs: JSDoc: Simplify language around type union custom types Co-Authored-By: Grzegorz (Greg) Ziółkowski <email@example.com> * Docs: JSDoc: Add reference to TypeScript function type syntax * Docs: JSDoc: Avoid own violations of record type guidelines * Docs: JSDoc: Correct BlockTitle example props usage Co-Authored-By: Grzegorz (Greg) Ziółkowski <firstname.lastname@example.org>