loreanvictor / tmplr

Automate Code Scaffolding
MIT License
27 stars 0 forks source link

The documentation for `run` and `use` is wrong #13

Closed loreanvictor closed 1 year ago

loreanvictor commented 1 year ago

run and use commands accept objects as arguments for with and read parameters, but in the documents they are written as strings. this is what the docs suggest:

run: some-recipe.yml
with:
  - x
  - y:
      path: './{{some-thing}}/whatever'
read:
  - z

while the correct format is:

run: some-recipe.yml
with:
  x: x
  y:
    path: './{{some-thing}}/whatever'
read:
  z: z