search

LEDApplications / lehd-schema

The LEHD schema files for the QWI, J2J, and PSEO data products
https://lehd.ces.census.gov/
Creative Commons Zero v1.0 Universal
0 stars 2 forks source link

Improve documentation on version metadata #14

Open jodyhoonstarr opened 2 years ago

jodyhoonstarr commented 2 years ago

Migrated from #41 on the old repo:

There had been a seldom-used and little-known convention to put a suffix on the end of the release (e.g., R2021Q1) in cases when a second release is made in a single quarter. Apparently this breaks the web app. Thus, we should probably end that convention.

We should be more clear that the internal vintage number will change in the rare event that a second release is made within a quarter.

For experimental/research releases, we do have the option of using a suffix on the release, to distinguish it from regular releases. That should be mentioned as well.

Note, this does not require a new schema number - it is a correction/technical edit to the text.

jodyhoonstarr commented 2 years ago

Feedback on this via email:

That problem might have been averted by more fully describing format of the version files in the schema: for example, we could publish a regular expression describing the format rather than letting consumers guess.