Skip to content

Proposed Variable Name Format #23

@lecy

Description

@lecy

@jsfenfen @borenstein

I think the current variable names are functional but they are hard to understand. When we have completed the first round of variable reconciliation (merges and splits), Nathan and I are willing to do a manual sweep of variable names to change to something a little more readable by applying consistent abbreviations. Something like this:

CURRENT RENAME
F9_01_PC_APAFPOSTATE F9_01_PC_PRINCIPAL_PROV_OR_STATE
F9_01_PC_APAZIPCODE F9_01_PC_ADDRESS_US_ZIPCODE
F9_01_PC_BENSPDTOMEMSPY F9_01_PC_BEN_PAID_MEMBERS_PRIOR
F9_01_PC_BENSPDTOMEMSPY F9_01_PC_BEN_PAID_MEMBERS_PRIOR
F9_01_PC_BEPATOMECUYE F9_01_PC_BEN_PAID_MEMBERS_CURRENT
F9_01_PC_BEPATOMEPRYE F9_01_PC_BEN_PAID_MEMBERS_PRIOR
F9_01_PC_CONGRACURYEA F9_01_PC_CONTR_GRANTS_CURRENT

In consulting with variable name length limits for software we have determined that 32 characters seems to be the upper limit, so we will respect that. It's longer than originally intended, but I think the gain in readability is worth it.

We will complete the rename process before the first official release.

Does this sound ok to everyone?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions