NWChemEx / NWChemEx/SimDE

Capitalization convention for input/result names in PTs

Open
#131 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
0
Forks
0
Avg merge
10h 7m
Merged PRs (30d)
4

Description

Right now we seem to have settled on "Title Case" for input/result names in property types. Since these names are akin to the names of kwargs, and since kwargs are usually lowercase, I suggest that we refactor the PTs to use lowercase names.

FWIW, the C++ infrastructure is setup to be case-insensitive so existing downstream C++ code should be okay as is. Python code assuming "Title Case" will need to change however.

Contributor guide

Open the contributing guide

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

Locate the property type definitions and the C++ and Python code that consumes their input/result names. Review how names are currently written and how the case-insensitive C++ infrastructure handles them. Done means the PT names consistently use lowercase and affected Python assumptions are updated without breaking existing C++ use.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp, python
Domain
backend-api-design
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.