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

tabular data package spec should be removed (or simplified) - as it adds unnecessary complexity #407

Closed
OriHoch opened this issue Apr 19, 2017 · 2 comments

Comments

@OriHoch
Copy link
Contributor

OriHoch commented Apr 19, 2017

preconditions

  • you are a user new to the datapackage ecosystem
  • you want to implement code that will work with any of the following:
    • simple datapackage that contains both simple resources and tabular resources
    • tabular datapackage that contains all tabular resources

reproduction steps

expected

  • be consistent with the frictionlessdata goal of "Requirements that are driven by simplicity"
    • there should be clear indication that some details from the specs repeat in the other specs
    • maybe best not to show the duplicated parts and instead show specs as extending other specs
    • see below for additional suggestions

actual

  • user has to read 3 specs which repeat the same specifications
    • for example - the paragraph about URIs repeats in all 3 specs, along with many other details
  • user might not understand that all the specs repeat the same details and that each one extends another spec
  • user might not understand that it's possible to implement the same code for handling the common details of the spec (instead of having to possibly support deviations - which may or may not exist now or in the future)

notes

  • it seems to me that it's overly complex to have a whole spec for tabular datapackage - when the only requirement in it is that all resources should be tabular data resources.
    • I think that the vast majority (if not all) of use-cases don't care about ensuring all resources are of a certain type. If there is an actual use-case for this - implementations could simply iterate over all the resources and check if they are all of the same resource type or not.
    • given the goal of simplicity - it makes sense to me to remove the tabular data spec completely and leave only the tabular data resource spec
@rufuspollock
Copy link
Contributor

FIXED (I hope!).

@OriHoch I hope this has been addressed in #418 work on readability. Can you take a quick look at the specs site now and see whether your concerns are addressed. Really appreciate the feedback 😄

@OriHoch
Copy link
Contributor Author

OriHoch commented May 24, 2017

yes, documentation is much clearer now! thanks

there is still duplication in the json spec files - but I guess it only matters to people that write datapackage library implementations.. so not worth to fix

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

No branches or pull requests

2 participants