update docs with params for run

[8ball030]

          can we include the params in this docstring - the docs will fail if not (can also do later lol)

Originally posted by @kevoconnell in #513 (comment)