Image-sequencer: Provide example of JSON style steps syntax in README

Created on 30 Jan 2019  Â·  4Comments  Â·  Source: publiclab/image-sequencer

In the docs here: https://github.com/publiclab/image-sequencer#string-syntax

we describe how a steps object can be passed in:

sequencer.importJSON(obj) //Imports the given sequence of JSON steps into sequencer

But we don't describe the formatting. I think there is an example in the tests, we can link to and/or quote in the docs. We should have a brief section below the string syntax section in the docs showing an example of the object syntax!

Also, we should ensure addSteps() can also accept a command JSON object too, as in #731 -- that could be a nice follow-up!

has-pull-request help wanted

All 4 comments

I would like to work upon this issue.

Please, that would be fantastic!

On Fri, Feb 1, 2019 at 3:52 PM Slytherin notifications@github.com wrote:

I would like to work upon this issue.

—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
https://github.com/publiclab/image-sequencer/issues/732#issuecomment-459863757,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AABfJ7j6RT2QJFTNbKeHIFCk0IDc1JIDks5vJKj4gaJpZM4aa3V6
.

@jywarren just one thing I want to ask that by saying 'command JSON object' does that mean JSON object from command line?

or in the JS console on a webpage. I think there are examples of this in
the tests, just not in the README!

On Sat, Feb 2, 2019 at 6:02 PM Slytherin notifications@github.com wrote:

@jywarren https://github.com/jywarren just one thing that by saying
'command JSON object' does that mean JSON object from command line?

—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
https://github.com/publiclab/image-sequencer/issues/732#issuecomment-460006992,
or mute the thread
https://github.com/notifications/unsubscribe-auth/AABfJ-b_D4b5xje7A14wcJfzjjuUetI2ks5vJhjsgaJpZM4aa3V6
.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

jywarren picture jywarren  Â·  5Comments

blurry-x-face picture blurry-x-face  Â·  4Comments

harshkhandeparkar picture harshkhandeparkar  Â·  5Comments

jywarren picture jywarren  Â·  3Comments

harshkhandeparkar picture harshkhandeparkar  Â·  4Comments