Docs/jest warning frontend tests#1148
Docs/jest warning frontend tests#1148JITENDRAGAHERWAR03 wants to merge 4 commits intoAOSSIE-Org:mainfrom
Conversation
📝 WalkthroughWalkthroughAdded two documentation notes to the Manual Setup Guide: one clarifying an innocuous ONNX Runtime warning on Windows 11, and one explaining a non-failing Jest "did not exit one second" warning and how to debug it. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/Manual_Setup_Guide.md`:
- Line 183: The markdown heading "### ONNX Runtime warning on Windows 11 (safe
to ignore)" has leading spaces; remove the leading spaces so the heading starts
at column 0 (i.e., change the line to begin with "### ONNX Runtime warning on
Windows 11 (safe to ignore)") to comply with Markdown conventions and fix the
indentation.
- Line 203: Update the compound modifier "dev-server related" to the hyphenated
form "dev-server-related" in the sentence containing "open async handles such as
timers, watchers, or dev-server related processes" so the phrase reads
"...timers, watchers, or dev-server-related processes."; edit the Markdown line
where that phrase appears and ensure spacing and punctuation remain correct.
🧹 Nitpick comments (1)
docs/Manual_Setup_Guide.md (1)
207-207: Format the npm command as a code block.For consistency with other commands in the documentation, the npm command should be formatted as a code block.
📝 Proposed fix
For debugging purposes, contributors can optionally run: -npm test -- --detectOpenHandles +```bash +npm test -- --detectOpenHandles +```
|
|
||
| For other systems, consult your distribution's documentation. | ||
|
|
||
| ### ONNX Runtime warning on Windows 11 (safe to ignore) |
There was a problem hiding this comment.
Fix heading indentation.
The heading has leading spaces, which violates markdown conventions. Headings should start at the beginning of the line (column 0).
📝 Proposed fix
- ### ONNX Runtime warning on Windows 11 (safe to ignore)
+### ONNX Runtime warning on Windows 11 (safe to ignore)📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### ONNX Runtime warning on Windows 11 (safe to ignore) | |
| ### ONNX Runtime warning on Windows 11 (safe to ignore) |
🧰 Tools
🪛 markdownlint-cli2 (0.20.0)
[warning] 183-183: Headings must start at the beginning of the line
(MD023, heading-start-left)
🤖 Prompt for AI Agents
In `@docs/Manual_Setup_Guide.md` at line 183, The markdown heading "### ONNX
Runtime warning on Windows 11 (safe to ignore)" has leading spaces; remove the
leading spaces so the heading starts at column 0 (i.e., change the line to begin
with "### ONNX Runtime warning on Windows 11 (safe to ignore)") to comply with
Markdown conventions and fix the indentation.
Summary
Adds documentation clarifying a common Jest warning that appears after successful frontend test runs.
Details
When running frontend tests, Jest may print the warning:
All tests still pass successfully, and the application functions as expected. This warning is typically caused by open async handles such as timers, watchers, or dev-server related processes and does not indicate a test failure.
Without clarification, this message can confuse new contributors into thinking the test suite or setup is broken.
This PR adds a short troubleshooting note explaining:
--detectOpenHandlesScope
Testing
Related Issue
Closes #1137
Summary by CodeRabbit