Added scatter variable to realize_lcs so that we can turn off scatter … #106
Conversation
…in realized light curves
| @@ -128,6 +128,11 @@ def realize_lcs(observations, model, params, thresh=None, | |||
| If True, only observations with times between | |||
| ``model.mintime()`` and ``model.maxtime()`` are included in | |||
| result table for each SN. Default is False. | |||
| scatter : bool, optional, defaults to True | |||
There was a problem hiding this comment.
Nitpick: "Default is True" should go at the end of the description, not on this line. See above parameter for example.
|
Fixed docstring by moving the default description to the end. Is that just the convention in this code, or is it something closer to pep8 and I should be trying to follow that even more generally? Could not figure out why is the travis ci check failing ? |
|
Change looks good. The specific format of docstrings are not specified by PEP8. Different projects use different conventions, but astropy and sncosmo use the numpydoc convention, which is detailed here: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt (search for "default"). The location of the default description is a very minor thing, but its better to just be consistent with the rest of the code. The travis failure is caused by a PEP8 error (line too long). run |
Completely agree on the consistency issue. |
Added scatter variable to realize_lcs so that we can turn off scatter
…in realized light curves