search

Nonprofit-Open-Data-Collective / irs-efile-master-concordance-file

The Master Concordance File defines standards and provides documentation necessary to build structured databases from the IRS E-File XML files posted on AWS.
https://nonprofit-open-data-collective.github.io/irs-efile-master-concordance-file/
40 stars 6 forks source link

Proposed Variable Name Format #23

Open lecy opened 6 years ago

lecy commented 6 years ago

@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?

borenstein commented 6 years ago

Looks great.

On Jan 18, 2018 2:57 PM, "Jesse Lecy" notifications@github.com wrote:

@jsfenfen https://github.com/jsfenfen @borenstein https://github.com/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?

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/Nonprofit-Open-Data-Collective/irs-efile-master-concordance-file/issues/23, or mute the thread https://github.com/notifications/unsubscribe-auth/AEPgnynH7S6ZC1D3TZTfk1XHK_q13rTCks5tL6IbgaJpZM4RjerM .

jsfenfen commented 6 years ago

That's great @lecy! When do you think that would happen?