OpenFOAM cases: Make editors understand dictionary files as C++ code
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- C
- Stars
- 142
- Forks
- 167
- Avg merge
- 20h 24m
- Merged PRs (30d)
- 11
Description
Motivated by https://github.com/precice/tutorials/pull/286#discussion_r935661658
Maybe we can do something like this with https://editorconfig.org/ or a similar specification format. Worst case, we inject some C++ comment in every file (as many OpenFOAM files often have, but we need to keep it consistent).
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 with the linked preCICE tutorials pull-request discussion and review the OpenFOAM case dictionary files in this repository. Compare an EditorConfig-based approach with the proposed C++ comment convention, then define a consistent editor-recognition mechanism that preserves valid tutorial cases.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100