Repository navigation
Document Sketch.arc overloads - #2120
Open
lucas-santos-f wants to merge 1 commit into
Open
lucas-santos-f wants to merge 1 commit into
lucas-santos-f wants to merge 1 commit into
Conversation
Describe the arguments of the three arc forms, in particular the start angle and angular span of the center/radius form. Fixes CadQuery#1663 Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2120 +/- ##
=======================================
Coverage 95.81% 95.81%
=======================================
Files 30 30
Lines 9605 9605
Branches 1443 1443
=======================================
Hits 9203 9203
Misses 247 247
Partials 155 155 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This branch has not been deployed
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.
Fixes #1663
Only the three-point form of
Sketch.archad a docstring, so the center/radius form shows up in the class reference with no hint of whataanddamean. This adds a docstring to each overload, the wayFace.normalAtdoes it; the multimethod Sphinx extension joins them under a single entry since #1123. The first line stays the generic "Construct an arc.", since that's the summary in the API reference table (see #1088).arc(p1, p2, p3): starts at p1, passes through p2, ends at p3arc(p2, p3): same, starting at the end of the last edgearc(c, r, a, da):ais the start angle in degrees from the x axis,dathe angle spanned, counter-clockwise if positive;abs(da) >= 360gives a full circleDocstrings only, no code change. Checked locally (Linux, Python 3.13, pip install with cadquery-ocp 8.0.1.1):
Sketch.arcin the class referenceblack . --diff --check(cq fork): nothing to reformatpytest -n 8 tests: 900 passed, 3 skipped (two gui tests that only run on Windows, one always skipped)mypy cadquery: same 10 errors as master, all inocc_impl/solver.py(pip casadi)Not touched here: for
abs(da) >= 360bothaand the sign ofdaare ignored, sinceEdge.makeCirclebuilds a full circle withoutangle1/orientation. Soarc((0, 0), 1, 90, 360)starts at (1, 0). I kept the docstring to "a full circle is made" for that case.AI disclosure: this change was written with the help of Claude Code (Claude Opus 5.5). Happy to adjust anything if needed.