docs: fix cosqi/sinqi doctest expected output#13375
Closed
Planeshifter wants to merge 1 commit into
Closed
Conversation
The job `Lint Changed Files` failed on develop with the `stdlib/tsdoc-declarations-doctest` ESLint rule reporting a mismatch in `docs/types/index.d.ts`: Expected entries [0,~0.707,~0.707,0,0,0,0,0], but observed [0.7071067811865476,0.7071067811865475,0,0,0,0,0,0] Root cause: the `cosqi` and `sinqi` TSDoc examples documented the twiddle-factor slice as starting with a leading `0` followed by the two `~0.707` entries, but running the actual code places the two `~0.707` entries at the start of the slice with no leading zero. This commit corrects both examples to `[ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ]`, matching the real output (verified by directly executing `cosqi`/`sinqi` against a workspace array and inspecting the resulting twiddle-factor slice). Ref: https://github.com/stdlib-js/stdlib/actions/runs/28921300699
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
Member
|
Closing, as this isn't just about doctesting. This is part of an ongoing fix which will be addressed in an actual PR. |
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
4 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.
Resolves None.
Description
This pull request:
@example"returns" comments inlib/node_modules/@stdlib/fft/base/fftpack/docs/types/index.d.tsfor thecosqiandsinqinamespace members.Related Issues
None.
Questions
No.
Other
Failing run: https://github.com/stdlib-js/stdlib/actions/runs/28921300699 (job:
Lint Changed Files, step:Lint TypeScript declarations files)Symptom:
stdlib/tsdoc-declarations-doctestESLint rule failed withExpected entries [0,~0.707,~0.707,0,0,0,0,0], but observed [0.7071067811865476,0.7071067811865475,0,0,0,0,0,0]at lines 97 and 189.Root cause: the
cosqi/sinqidoc examples documented the twiddle-factor slice with a leading0before the two~0.707entries; the actual runtime output places the two~0.707entries first, with no leading zero.Fix: corrected both examples to
[ ~0.707, ~0.707, 0, 0, 0, 0, 0, 0 ], verified against the real output ofcosqi/sinqi.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written primarily by Claude Code as part of an automated CI-failure triage and fix routine, based on live GitHub Actions job log analysis and direct execution of the affected code to confirm expected output. The fix was reviewed by three independent automated review passes (correctness, regression scope, style/conventions) before being proposed here; all approved.
@stdlib-js/reviewers
Generated by Claude Code