Alias list_name to dataset in entities sheet #654
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #652
Why is this the best possible solution? Were any other approaches considered?
The intent is to match the user-facing language of "Entity List". We discussed some alternative column names but decided that
list_name
has the advantage of being consistent with thechoices
sheet. The meanings are slightly different but very much related.I went back and forth on the text of error messages. At first I made them generic ("Invalid name") but then I thought that would be too hard to use. I think using "entity list" in the messages is friendlier. People who have existing forms with
dataset
are early adopters so hopefully are in a better position to figure out the issue if they run into the message.I also added on case-sensitive checking of reserved entity property names.
What are the regression risks?
This area is well-tested and the change is small so I don't think there are any.
Does this change require updates to documentation? If so, please file an issue here and include the link below.
getodk/docs#1651
Before submitting this PR, please make sure you have:
tests
nosetests
and verified all tests passblack pyxform tests
to format code