Skip to content

Update docs and add descriptive error message#128

Merged
svchb merged 1 commit intomainfrom
ef/periodicity-docs
Sep 5, 2025
Merged

Update docs and add descriptive error message#128
svchb merged 1 commit intomainfrom
ef/periodicity-docs

Conversation

@efaulhaber
Copy link
Member

@efaulhaber efaulhaber commented Sep 5, 2025

  • Removed the non-existent kwarg periodicity from the docstrings.
  • Added a descriptive error message when the type of the periodic box does not match the type of the search radius and also added a note to the docs.

Find the rendered docs for this PR here:
https://trixi-framework.github.io/PointNeighbors.jl/previews/PR128/

@efaulhaber efaulhaber requested a review from Copilot September 5, 2025 07:51
@efaulhaber efaulhaber self-assigned this Sep 5, 2025
@efaulhaber efaulhaber added the documentation Improvements or additions to documentation label Sep 5, 2025
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_radius and PeriodicBox have matching element types
  • Removed references to non-existent periodicity parameter 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.

@efaulhaber efaulhaber requested review from LasNikas and svchb September 5, 2025 07:52
@codecov
Copy link

codecov bot commented Sep 5, 2025

Codecov Report

❌ Patch coverage is 66.66667% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 87.84%. Comparing base (edf29bb) to head (022380d).
⚠️ Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/nhs_grid.jl 50.00% 1 Missing ⚠️
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     
Flag Coverage Δ
unit 87.84% <66.66%> (-0.11%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 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.

@svchb svchb enabled auto-merge (squash) September 5, 2025 08:03
@svchb svchb merged commit 1330422 into main Sep 5, 2025
10 of 12 checks passed
@svchb svchb deleted the ef/periodicity-docs branch September 5, 2025 08:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants