docs: fix TSDoc errors in @stdlib/assert declarations#12454
Open
Planeshifter wants to merge 1 commit into
Open
docs: fix TSDoc errors in @stdlib/assert declarations#12454Planeshifter wants to merge 1 commit into
@stdlib/assert declarations#12454Planeshifter wants to merge 1 commit into
Conversation
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
c3b10c0 to
38da3a3
Compare
Correct documentation-only defects across `@stdlib/assert` ambient
declaration files (TSDoc comments only; no type or runtime changes):
- Fix copy-pasted/wrong `@returns` and summary prose: `is-symbol-array`
("array of strings" -> symbols), `is-probability-array` ("positive
integer" -> probabilities), `is-undefined-or-null` (omitted "or
null"), `is-nonpositive-number-array` ("integer" -> "number"), and
`is-nonpositive-finite` (missing "finite").
- Fix incorrect `@example` annotations: `is-positive-finite` (`Infinity`
marked "returns true"), `is-iterable-like` (placeholder `<boolean>`),
and `is-nan-array` (missing `// returns`).
- In `is-bigint` and `is-symbol`, demonstrate the main function in the
top-level `@example` blocks (previously only sub-methods were shown)
and remove a duplicated `@example` block.
- Repair `HasFunction` summaries/examples in `deep-has-own-property` and
`deep-has-property` to describe the returned one-argument tester.
- Miscellaneous: strip JSDoc-style `{*}`/`{boolean}` tags in
`is-nonnegative-finite`, convert backtick example strings to single
quotes in `is-kebabcase`, give continuation examples their own
`@example` tags in `is-startcase`, add the missing `## Notes` block in
`is-same-typed-array-like`, and remove stray/double whitespace.
---
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
---
38da3a3 to
60f5767
Compare
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 corrects documentation-only defects (TSDoc comments only; no type or runtime changes) across
@stdlib/assertambient declaration files:@returnsand summary prose:is-symbol-array("array of strings" -> symbols),is-probability-array("positive integer" -> probabilities),is-undefined-or-null(omitted "or null"),is-nonpositive-number-array("integer" -> "number"), andis-nonpositive-finite(missing "finite").@exampleannotations:is-positive-finite(Infinitymarked "returns true"),is-iterable-like(placeholder// returns <boolean>), andis-nan-array(missing// returns).is-bigintandis-symbol, demonstrates the main function in the top-level@exampleblocks (previously only sub-methods were shown) while retaining.isPrimitive/.isObjectexamples, and removes a duplicated@exampleblock.HasFunctionsummaries/examples indeep-has-own-propertyanddeep-has-propertyto describe the returned one-argument tester.{*}/{boolean}tags inis-nonnegative-finite, converts backtick example strings to single quotes inis-kebabcase, gives continuation examples their own@exampletags inis-startcase, adds the missing## Notesblock inis-same-typed-array-like, and removes stray/double whitespace.Related Issues
No.
Questions
No.
Other
Identified via a TypeScript-declaration audit of the
@stdlib/assertnamespace. Non-documentation (type/signature) fixes are submitted as separate pull requests. The auto-generated namespace aggregator declaration (docs/types/index.d.ts) is intentionally left untouched.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored primarily by Claude Code (Anthropic's CLI), which audited the
@stdlib/assertTypeScript declarations and proposed and applied the documentation fixes. I reviewed the changes.@stdlib-js/reviewers