Known docstring issues

[aaraney]

• from_list in job scheduler and its api method need to be more verbose and include an example.

• perturb_parameters in paramter_editor needs to be updated. Has the old version docstring

[cheginit]

I was wondering which docstring style are you adhering to? I personally prefer numpydoc and use their library to check the style.

[aaraney]

@cheginit I wasn't following a strict style, which admittedly I should. Since so many of the method aren't directly exposed via the api, I mainly just wanted to give a general gist of what what occurring in the function with a mandatory example. I really like how man pages have examples, so whatever style I end up adopting full time, I would like it to commonly include examples.

[cheginit]

When you want to use readthedocs you should follow a known docstring style so they can be rendered properly. I tend to add at least a one-line docstring for all the functions.