Update docs and add descriptive error message#128
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR improves error handling and documentation for neighborhood search functionality by adding type checking between search radius and periodic box parameters, and cleaning up outdated documentation.
- Added type validation to ensure
search_radiusandPeriodicBoxhave matching element types - Removed references to non-existent
periodicityparameter from docstrings - Added documentation note about type requirements for single precision usage
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/nhs_grid.jl | Added type validation and documentation note about type matching requirements |
| src/neighborhood_search.jl | Added eltype method for PeriodicBox to support type checking |
| src/cell_lists/full_grid.jl | Cleaned up docstring by removing non-existent periodicity parameter |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #128 +/- ##
==========================================
- Coverage 87.94% 87.84% -0.11%
==========================================
Files 15 15
Lines 622 625 +3
==========================================
+ Hits 547 549 +2
- Misses 75 76 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
periodicityfrom the docstrings.Find the rendered docs for this PR here:
https://trixi-framework.github.io/PointNeighbors.jl/previews/PR128/