lanl / lanl/singularity-eos

Inconsistent naming conventions of class member variables / C++ standards violations

Open
#255 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

clean-up good first issue help wanted
Dominant language
C++
Stars
39
Forks
22
Avg merge
10h 22m
Merged PRs (30d)
3

Description

Within the context of singularity-eos we have different conventions for naming private variables which are members of classes. For nearly all of the analytic EOSs (for which I was mostly responsible) we use a leading underscore for private member variables. In such class scope, this is allowed under the standard, but only if the next character is neither an underscore nor a capital letter. This is part of C++ standards, and while it is likely to work without issue, it's technically reserved.

I propose changing all of the private member variables to trailing underscores, which is consistent with the tabular EOS implementations (both spiner and EOSPAC) and is not standards violating.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inventorying private member variables across the analytic EOS implementations and compare their naming with the tabular EOS implementations. Update the affected names to use trailing underscores, then verify that all references compile and the project tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.