docs: update TypeScript documentation and fix whitespace in nlp/lda declarations#12730
Merged
Conversation
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
---
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
added
Documentation
kgryte
approved these changes
Jun 10, 2026
kgryte
changed the title
nlp/lda declarationsnlp/lda declarations
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request fixes TSDoc completeness and a whitespace inconsistency in the
@stdlib/nlp/ldaTypeScript declaration file (docs/types/index.d.ts). The changes are documentation-only and do not affect type-checking or runtime behavior:@throws first argument must be an array of stringstag, which the implementation (lib/main.js) documents and throws at runtime but the declaration omitted.alpha/betadefaults (50/Kand0.1) on their@paramlines, matching theOptionsinterface, the implementation, and the file's own convention (e.g. thegetTermsnoparam already states(default: 10)).Options.betadescription.Related Issues
No.
Questions
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
The declaration issues were surfaced by a Claude Code TypeScript-declarations audit and verified against the implementation; the fixes were reviewed and applied with Claude Code.
@stdlib-js/reviewers