trixi-framework / trixi-framework/Trixi.jl
Make `DGMulti` names more descriptive
Open
Nobody has claimed this yet.
consistency
- Dominant language
- Julia
- Stars
- 731
- Forks
- 167
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 25
Description
As usual, I am a big fan of self-descriptive names, i.e., inverse_jacobian and inverse_wq (or inverse_whatevergoodnamethereis) 😬
Originally posted by @sloede in https://github.com/trixi-framework/Trixi.jl/pull/1029#discussion_r782217403
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 locating the DGMulti names discussed in the issue and read the linked pull-request discussion for the naming context. Review the surrounding names for consistency; done means the DGMulti-related names are more descriptive and the existing references remain consistent.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- hpc
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100