lanl/singularity-eos

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

Open

#255 opened on Apr 18, 2023

View on GitHub
 (1 comment) (2 reactions) (0 assignees)C++ (21 forks)auto 404
clean-upgood first issuehelp wanted

Repository metrics

Stars
 (36 stars)
PR merge metrics
 (PR metrics pending)

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

Research direction
Identify all private member variables with leading underscores in analytic EOS classes and rename them to trailing underscores.
Tech stack
cpp
Domain
hpc
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80