openva / crump

A parser for the Virginia State Corporation Commission's business registration records.
https://vabusinesses.org/
MIT License
20 stars 3 forks source link

Move "description" field in YAML #50

Closed waldoj closed 10 years ago

waldoj commented 10 years ago

The present order of fields is confusing:

- name:        table-identifier
  type:        A
  start:       2
  length:      2
  description: ID for Specific Table
- name:        table-code
  type:        A
  start:       4
  length:      10
  description: Table code
- name:        table-desc
  type:        A
  start:       14
  length:      50
  description: Value for Table Code

Putting name first and description last makes it logical for a reader to group together descriptions and the following name, even though they're unrelated. Move the description field up to appear after name to prevent this confusion.