Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Inconsistencies in Inspections dataset #57

Open
mmartin78 opened this issue Jul 29, 2015 · 3 comments
Open

Inconsistencies in Inspections dataset #57

mmartin78 opened this issue Jul 29, 2015 · 3 comments

Comments

@mmartin78
Copy link

Why do some inspection fields start with "Insp" like InspType, InspTypeMapped and other start with "Inspection" like InspectionNotes? I would suggest to go with the complete word to be more descriptive, but otherwise at the very least there should be consistency.

@eddietejeda
Copy link
Contributor

We discussed such a broad set of issues on the requirements and definitions that I think we were less finicky about naming. But we should clean this up. I am in a favor of more descriptive names.

In this example, InspTypeMapped should be InspectionTypeMapped.

The concern is backwards compatibility. Luckily, we have an advantage, since many of us work directly with the agencies publishing the data. But that's a bigger discussion.

@mmartin78
Copy link
Author

Since the standard has not been adopted by many jurisdictions just yet, I would try to issue a revision as soon as possible.

Otherwise, the fields can be marked as "deprecated" for a period of time and the new naming adopted to allow for both names for a period of time (or until release 2.0) at which point the old name can be finally removed.

@bettin
Copy link

bettin commented Aug 4, 2015

As was pointed out, renaming fields like this is a breaking change. I would suggest adding this to be considered as part of a future major release (2.0 for example).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants