trixi-framework / trixi-framework/PointNeighbors.jl
To-Do for API and docs
Open
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 27
- Forks
- 10
- PR merge metrics
- No merged PRs in 30d
Description
- #27
- Write README.
- Rename
for_particle_neighbortoforeach_point_neighbor. - Replace
particlebypointeverywhere. - Add benchmark plot to README.
- Write comparison table for all implementations.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing README and the current for_particle_neighbor API references first. Complete the checklist by writing the README, applying the requested particle to point terminology and rename, and adding the benchmark plot and comparison table. Done means all unchecked items are completed and the documented API matches the implementation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- api, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100