John McCardle
23d7882b93
The normalize() method's implementation returns a zero vector when called on a zero-magnitude vector, rather than raising ValueError as the documentation claimed. Updated the MCRF_RAISES to MCRF_NOTE to accurately describe the actual behavior. Also added test coverage in tools/test_vector_docs.py to verify the normalize() docstring contains the correct Note section. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
27 lines
775 B
Python
27 lines
775 B
Python
import mcrfpy
|
|
import sys
|
|
|
|
# Check Vector.magnitude docstring
|
|
mag_doc = mcrfpy.Vector.magnitude.__doc__
|
|
print("magnitude doc:", mag_doc)
|
|
assert "magnitude()" in mag_doc
|
|
assert "Calculate the length/magnitude" in mag_doc
|
|
assert "Returns:" in mag_doc
|
|
|
|
# Check Vector.dot docstring
|
|
dot_doc = mcrfpy.Vector.dot.__doc__
|
|
print("dot doc:", dot_doc)
|
|
assert "dot(other: Vector)" in dot_doc
|
|
assert "Args:" in dot_doc
|
|
assert "other:" in dot_doc
|
|
|
|
# Check Vector.normalize docstring
|
|
normalize_doc = mcrfpy.Vector.normalize.__doc__
|
|
print("normalize doc:", normalize_doc)
|
|
assert "normalize()" in normalize_doc
|
|
assert "Return a unit vector" in normalize_doc
|
|
assert "Returns:" in normalize_doc
|
|
assert "Note:" in normalize_doc
|
|
|
|
print("SUCCESS: All docstrings present and complete")
|
|
sys.exit(0)
|