Skip to content

Add a debugging tutorial to the docs - #2113

Open
xdsky wants to merge 1 commit into
CadQuery:masterfrom
xdsky:add-debugging-doc
Open

xdsky wants to merge 1 commit into
CadQuery:masterfrom
xdsky:add-debugging-doc

Conversation

@xdsky

@xdsky xdsky commented Oct 18, 2026

Copy link
Copy Markdown

Adds a debugging guide to the documentation. It covers: breaking a chain into smaller steps; inspecting the current selection (size, vals, all, val); selectors that match nothing; the "Cannot find a solid" error raised by findSolid; checking a shape with isValid, Volume and BoundingBox; and exporting intermediate results. All examples use non-executed code-block directives.

Closes #612

@codecov

codecov Bot commented Oct 18, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.81%. Comparing base (5f5bc62) to head (03fef1b).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2113   +/-   ##
=======================================
  Coverage   95.81%   95.81%           
=======================================
  Files          30       30           
  Lines        9599     9599           
  Branches     1441     1441           
=======================================
  Hits         9197     9197           
  Misses        247      247           
  Partials      155      155           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@adam-urbanczyk

Copy link
Copy Markdown
Member

Thanks @xdsky! To what extent was this LLM generated?

@xdsky

xdsky commented Oct 23, 2026

Copy link
Copy Markdown
Author

Thanks! Honestly, it was AI-assisted for the initial draft, but I went through it myself and checked the workflow actually works - the debug()/inspect() parts are from my own use. If anything reads off or doesn't match the project's style, just point it out and I'll fix it.

@adam-urbanczyk

Copy link
Copy Markdown
Member

I see three issues:

(1) CQ is not limited to the fluent/Workplane API
(2) You can invoke stuff with invoke without breaking the chain
(3) You mention vis capabilities and exporting+using external viewers. That is a contradiction, there is no need to use external viewers. Additionally, one can visualize things likes locations or vectors.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a tutorial about debugging to the docs

2 participants