docs: add doctests to core modules

[tschm]

Add executable examples to docstrings for:

• Circle class and contains() method
• perpendicular_slope() function
• min_circle_cvx() function

Summary by CodeRabbit

• Documentation
  • Enhanced documentation with practical examples demonstrating usage and expected outputs across the codebase.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

Three source files received documentation enhancements through the addition of example sections to existing docstrings. The min_circle_cvx function, Circle class, and perpendicular_slope function now include usage examples demonstrating expected behavior. No functional code modifications were made.

Changes

Cohort / File(s)	Summary
Documentation Examples src/min_circle/cvx.py, src/min_circle/utils/circle.py, src/min_circle/welzl.py	Added Examples sections to function and class docstrings: min_circle_cvx demonstrates solver usage with a 2-point case; Circle class and contains method show instantiation and membership testing; perpendicular_slope illustrates behavior for horizontal and non-horizontal point pairs.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Three docstrings bloomed with examples so bright,
Circle slopes and convex hulls taking flight,
No logic touched, just wisdom displayed,
Documentation's a garden where examples are made! 📚✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately describes the main change: adding documentation examples (doctests) to core modules. It is concise, specific, and directly relates to the primary objective of the changeset.
Docstring Coverage	✅ Passed	Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing touches

• 📝 Generate docstrings

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}