Skip to content

Fix four default values in docstrings - #2134

Open
ZainnQureshii wants to merge 1 commit into
CadQuery:masterfrom
ZainnQureshii:docs/docstring-defaults
Open

ZainnQureshii wants to merge 1 commit into
CadQuery:masterfrom
ZainnQureshii:docs/docstring-defaults

Conversation

@ZainnQureshii

Copy link
Copy Markdown

Four docstrings gave default values that differ from their signatures:

  • Workplane.parametricSurface: tol 1e-3 -> 1e-2 and maxDeg 3 -> 6 (cadquery/cq.py:1991, :1993)
  • Face.makeSplineApprox: maxDeg 6 -> 3 (cadquery/occ_impl/shapes.py:3752)
  • Solid.sweep: transitionMode 'right' -> 'transformed' (both overloads, shapes.py:4679 and :4736)

Docstrings only, no behaviour change. Each value was compared to its signature, and a script that checks every (default: ...) in the changed docstrings against the signature reports no mismatch after the change.

Prepared with AI assistance (Claude Code) and reviewed with GitHub Copilot.

🤖 Generated with Claude Code

Workplane.parametricSurface defaults to tol=1e-2 and maxDeg=6,
Face.makeSplineApprox to maxDeg=3, and both Solid.sweep overloads to
transitionMode='transformed', but the docstrings said 1e-3, 3, 6 and
'right'.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@codecov

codecov Bot commented Nov 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.81%. Comparing base (477d87d) to head (2905da5).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2134   +/-   ##
=======================================
  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.
📢 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.

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

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant