hdc-arizona / roundtrip

MIT License
12 stars 2 forks source link

Readme feedback #1

Closed alex-r-bigelow closed 5 years ago

alex-r-bigelow commented 5 years ago

Aside from minor formatting fixes, I moved the example to the top. The flow felt a little unnatural to walk through (especially if you're new to / haven't yet installed jupyter).

Some additional feedback:

jessebartels commented 5 years ago

Aye, these are some solid points:

  1. The require.config is indeed for external dependencies (with simple examples we've mostly just used D3 but I can imagine more complex projects needing to specify heftier javascript dependencies). I'll update the readme to be more specific about require.config
  2. I've played around with allowing users to load multiple javascript files versus one javascript file and I'm unsure which is better. Currently I have it so that all javascript files get sourced(i.e. if there are values you want to store in a separate file), but only the first argument is used in the actual Display call. I'll update the readme with this info and we can decide which is the best option.