chore: Fix documentation generation warnings. (#9325)

* chore: Replace @yields with @returns.

* fix: Update the ESLint config to not require @yields.

* chore: Move docs onto getters.
This commit is contained in:
Aaron Dodson
2025-08-19 14:56:59 -07:00
committed by GitHub
parent 405f7da280
commit ac7619a622
4 changed files with 5 additions and 9 deletions

View File

@@ -89,7 +89,8 @@ function buildTSOverride({files, tsconfig}) {
'@typescript-eslint/no-explicit-any': ['off'],
// We use this pattern extensively for block (e.g. controls_if) interfaces.
'@typescript-eslint/no-empty-object-type': ['off'],
// TSDoc doesn't support @yields, so don't require that we use it.
'jsdoc/require-yields': ['off'],
// params and returns docs are optional.
'jsdoc/require-param-description': ['off'],
'jsdoc/require-returns': ['off'],