trixi-framework / trixi-framework/TrixiParticles.jl
Avoid misleading names in docs: Parallelogram instead of plane
Open
Nobody has claimed this yet.
discussion
documentation
- Dominant language
- Julia
- Stars
- 83
- Forks
- 24
- Avg merge
- 8d 18h
- Merged PRs (30d)
- 3
Description
As discussed in #437:
https://github.com/trixi-framework/TrixiParticles.jl/pull/437#discussion_r1543045977
Contributor guide
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
Start by reading issue #437 and the linked pull request discussion, which contains the naming context. Search the documentation for the misleading use of “plane” and update the relevant terminology to “parallelogram”; done means the affected documentation no longer uses the incorrect name.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100