search

dwavesystems / demos

WARNING: This repo is obsolete. For D-Wave Ocean code examples, go to the `dwave-examples` GitHub account.
https://github.com/dwave-examples
Apache License 2.0
39 stars 37 forks source link

Add expected inputs and outputs in README #63

Open m3ller opened 5 years ago

m3ller commented 5 years ago

Application Some thought needs to be put into how to convey inputs/outputs of a demo to the user.

I got feedback that demos README.rst should display the input/output of a demo. However, many of the demos are scripts, so it feels odd (to me) to describe the input and output of said script. (i.e. a script is different from a function)

Anyway, this requires more thought.

arcondello commented 5 years ago

I do think it's important that the demos explain how to alter the input, e.g. for the map-coloring how to add you're on map. However, I don't think there needs to be a specific format for all of the demos. Some of the demos might require a file, others might have the input right in the script.

randomir commented 5 years ago

There was a time when all the cool kids had animated gifs in their readmes. Seems like that time has passed, but food for thought. :smiley:

danicamarsden commented 5 years ago

So per Alex's comment, perhaps just an optional section with inputs/outputs where and as makes sense, and examples of what these could be/look like?