search

jsa-aerial / hanami

Interactive arts and charts plotting with Clojure(Script) and Vega-lite / Vega. Flower viewing 花見 (hanami)
MIT License
393 stars 12 forks source link

Attempt to clarify substitution example paragraph #18

Open mars0i opened 2 years ago

mars0i commented 2 years ago

(Hi - Are you open to PRs for the README file? I'm learning hanami, which is great, by the way. I'd like to offer some suggested changes to the README bit by bit as I study Hanami and the README further.)

i.e. this is a revision to the current 4th paragraph in section "Templates, Substitution Keys and Transformations".

I think the previous version of this paragraph made sense once you understood what Hanami was doing overall, but I found it confusing the first few times that I read it. The new version is longer, but I hope that it spells things out better for someone new to the Hanami process.

mars0i commented 2 years ago

Let me know if this should go in a new branch, and if you want me to squash the new commit into the original.