docs: Fix README and CONTRIBUTING inconsistencies with implementation #56
Conversation
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
- Update README.md API Reference to match actual implementation - Add detailed parameter descriptions for all methods - Include missing getter methods for precision control - Fix insert() signature to show optional parameters - Add len() and n property documentation - Remove "(2D only)" from varargs query (works for 3D/4D too) - Add return type annotations for clarity - Update CONTRIBUTING.md project structure - Update file paths to reflect current project layout - Change cpp/ to include/prtree/core/ and src/cpp/bindings/ - Update Python wrapper path from __init__.py to core.py - Add pyproject.toml to project structure - Update test directory structure (unit/integration/e2e) All examples verified to work correctly with current implementation.
Major improvements: 1. **README.md**: - Clarified Thread Safety section with detailed explanations - Distinguished between read and write operations - Added concrete examples of thread-safe usage patterns - Explained when external synchronization is needed 2. **src/python_prtree/core.py**: - Added comprehensive docstrings to all classes and methods - Included detailed Args, Returns, Raises, Examples sections - Added performance complexity analysis - Documented thread safety for each method - Added See Also cross-references - Explained precision selection behavior - Provided extensive usage examples for each method 3. **docs/README.md** (new): - Created documentation directory guide - Explained purpose of each subdirectory - Added navigation guide for users and developers Documentation now follows NumPy/Google docstring style with: - Complete parameter descriptions with types - Return value specifications - Exception documentation - Performance characteristics - Thread safety notes - Practical examples for all methods - Cross-references between related methods All README examples verified to work correctly with implementation.
Thoroughly verified all documentation against actual implementation and fixed the following inconsistencies: **README.md:** - Removed precision control methods (set/get_adaptive_epsilon, etc.) that are not exposed in the Python API. These methods exist in C++ bindings but are not accessible to users through the Python wrapper. **docs/DEVELOPMENT.md:** - Removed reference to non-existent benchmarks/python/ directory - Removed tests/legacy/ from test organization section (internal only) - Fixed cross-reference paths to use ../ prefix (CONTRIBUTING.md, README.md, CHANGES.md) since DEVELOPMENT.md is in docs/ subdirectory **docs/ARCHITECTURE.md:** - Removed benchmarks/python/README.md from directory structure - Added tests/legacy/ directory to test suite structure **Makefile:** - Fixed CPP_DIR variable from 'cpp' to 'src/cpp' to match actual directory structure All changes verified with tests - README examples still pass.
atksh
deleted the
claude/verify-and-update-readme-011CUxJqAKK8x1okH4QngNmd
branch
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.
Update README.md API Reference to match actual implementation
Update CONTRIBUTING.md project structure
All examples verified to work correctly with current implementation.