From 2df15b4a66ccdfaa08bd3ac3a8014f4b792aabe6 Mon Sep 17 00:00:00 2001 From: Philipp Burckhardt Date: Tue, 9 Jun 2026 00:16:25 -0500 Subject: [PATCH] docs: fix TSDoc completeness and whitespace in `nlp/lda` declarations Add the missing `@throws first argument must be an array of strings` tag, document the `alpha`/`beta` defaults on their `@param` lines, and remove a stray double space after the asterisk in the `Options.beta` description. These bring the declaration TSDoc in line with the implementation (lib/main.js) and the file's own conventions. --- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown_pkg_readmes status: na - task: lint_markdown_docs status: na - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed --- --- lib/node_modules/@stdlib/nlp/lda/docs/types/index.d.ts | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/lib/node_modules/@stdlib/nlp/lda/docs/types/index.d.ts b/lib/node_modules/@stdlib/nlp/lda/docs/types/index.d.ts index ab10130c574a..55438e5f9b05 100644 --- a/lib/node_modules/@stdlib/nlp/lda/docs/types/index.d.ts +++ b/lib/node_modules/@stdlib/nlp/lda/docs/types/index.d.ts @@ -28,7 +28,7 @@ interface Options { alpha?: number; /** - * Dirichlet hyper-parameter for word vector phi (default: `0.1`). + * Dirichlet hyper-parameter for word vector phi (default: `0.1`). */ beta?: number; } @@ -76,8 +76,9 @@ interface Model { * @param documents - document corpus * @param K - number of topics * @param options - options object -* @param options.alpha - Dirichlet hyper-parameter of topic vector theta -* @param options.beta - Dirichlet hyper-parameter for word vector phi +* @param options.alpha - Dirichlet hyper-parameter of topic vector theta (default: 50/K) +* @param options.beta - Dirichlet hyper-parameter for word vector phi (default: 0.1) +* @throws first argument must be an array of strings * @throws second argument must be a positive integer * @throws must provide valid options * @returns model object