-
Notifications
You must be signed in to change notification settings - Fork 4
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
Add new fare_action enum options to fare_transactions #122
Conversation
Added the new actions discussed in the linked issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Jay, thank you for this pull-request. I think this looks great, but I'm concerned that the enum values themselves aren't quite self-documenting. If I hadn't read the linked issue I'm not sure what I would have interpreted "Capture" to mean. I see a few options,
- This is industry standard vocabulary and additional description isn't necessary
- The enum values could be longer to provide a succinct description, e.g.,
Button pressed by driver or operator to indicate a boarding or alighting passenger
from fare_transactions.media_type. - Leave the enum values the same and add descriptions of them to the
description
property.
I like the third option the most. Even if it is industry-standard, some may not be sure what it means. I don't like long enum values because they bloat data files. (At Korbato we use numeric IDs pointing to an enum table.) |
I prefer the third option too. |
If we're in agreement I can implement option 3 and add the id and description of each enum value in the description field. I think newlines and tabs would be useful here but I'm not sure how that's parsed. Should I do a single escape ( |
Are we still waiting on response to how to add newlines and tabs to the description field? @e-lo @j-meelah @SorenSpicknall do you have any thoughts on that? |
Re Enums... I like Option 3 and use it in other projects:
Getting it to render a newline might take trial and error, but I believe that HTML <br>- Value 1<br>- Value 2<br>- Value 3 Another option would be to make an unordered list, which I've done before too. |
And, while I believe that self-documenting within the schema is the right way to go, there is the option to define an RDF type in a separate json-file which could be self-documenting....but gross IMHO. |
Also... submitted frictionlessdata/datapackage#843 for people to add their own thoughts to |
Added enum descriptions, trying html line breaks
Documentation available at: |
Added the new actions discussed in the linked issue.
Pull Request
Before submitting a pull request, please read CONTRIBUTING.md.
For spec changes:
By contributing to this project, all contributors certify to the Developer Certificate of Origin in CONTRIBUTING.md.