docs: document @throws for math/base/utils/float64-epsilon-difference#12465
Open
Planeshifter wants to merge 1 commit into
Open
docs: document @throws for math/base/utils/float64-epsilon-difference#12465Planeshifter wants to merge 1 commit into
@throws for math/base/utils/float64-epsilon-difference#12465Planeshifter wants to merge 1 commit into
Conversation
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
…nce`
Add the `@throws must provide a recognized scale function name` tag that
the sibling `relative-difference` documents. `epsilonDifference` accepts
the same `scale` argument and delegates to `reldiff`, which throws on an
unrecognized scale-name string, so the declaration should document it.
This PR addresses only the TypeScript declaration file.
---
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
---
Planeshifter
force-pushed
the
philipp/docs-fix-math-misc-declarations
branch
from
ec5a8de to
fd406b2
Compare
Planeshifter
changed the title
@stdlib/math declarations@throws for math/base/utils/float64-epsilon-difference
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
2 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 adds the
@throws must provide a recognized scale function nametag to the@stdlib/math/base/utils/float64-epsilon-differencedeclaration, which the siblingrelative-differencedocuments.epsilonDifferenceaccepts the samescaleargument and delegates toreldiff, which throws on an unrecognized scale-name string, so the declaration should document it.Related Issues
No.
Questions
No.
Other
Found via a TypeScript-declaration audit of the
@stdlib/mathnamespace.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This issue was identified by an automated TypeScript-declaration audit run with Claude Code, and the fix was prepared by Claude Code under my review.
@stdlib-js/reviewers