docs: fix and align TSDoc comments in iter declarations#12726
Merged
Conversation
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
b3c8833 to
df3bd26
Compare
---
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
---
df3bd26 to
40d250d
Compare
kgryte
approved these changes
Jun 10, 2026
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
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 documentation-only (TSDoc) defects and inconsistencies in the TypeScript declaration files of
iterpackages, surfaced by an audit of the namespace. No runtime behavior or emitted types change. Changes:do-while-each: fix a malformed inline-code span (thus, fcn`→thus, `fcn`) in the summary.replicate-by: replace a stale, copy-pasted summary ("invokes a function for each iterated value") with the correct "replicates each iterated value according to a provided function".pipeline-thunk: fixIteratorFunction@returns hash value→@returns iterator function result(copy-paste from an unrelated function) and add the missing terminating period to its summary.cusome-by: fix@param nfrom "minimum number of truthy elements" (the non-predicatecusomewording) to "minimum number of successful values" (ncounts predicate-passing values, matchingsome-by).dedupe-by: fix theCallbackunion doc block which named a nonexistentprevparam and omitted the realsprev/dprev(now mirrors the maximal-arityQuinarymember).strided: document(default: false)for the optionaleagerparam, matching the siblingstrided-byand the implementation.fill: document@param begin(default: 0), matching the siblingsliceand the implementation.datespace: remove a stray space in(default: 'floor' )to match the first overload.cusome: complete a truncated@example(// ..) with the family's closingdoneassertion (matchingcuany/cuevery/cunone).do-until-each: add thereturnskeyword to an@exampleannotation (// undefined→// returns undefined) for consistency with every other annotation in the block.Related Issues
No.
Questions
One change aligns an outlier with its sibling family rather than fixing an outright error: the
cusomeexample completion (replacing a// ..placeholder with the family's closingdoneassertion). Happy to drop it if reviewers consider it out of scope for a docs-fix PR.Other
These changes were identified via a systematic audit of the
iternamespace's TypeScript declarations and then re-checked against the broader namespace conventions. Two candidate findings were intentionally dropped after that re-check: removing thePredicateunion@paramtags inany-by(all-bysiblings carry them, so removal would create an outlier) and adding index-argument@throwstoto-array-view(onlyto-array-view-rightdocuments these;fill/slice/stridedomit them, so the sibling is the anomaly). The companionrefactor:changes (helper-type renames andany/unknownalignment) are submitted as separate PRs.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
The TSDoc inconsistencies were surfaced by an AI-assisted audit (Claude Code) of the
iternamespace declarations, and the fixes were drafted with Claude Code. Each finding was verified against the actual declaration files, implementations, and sibling-package conventions before applying; several candidate findings were discarded as false positives or convention violations.@stdlib-js/reviewers