Adding new argument to spatial-raster.rst and changing comments in Spatial.py to PEP8 format about earthpy

[willskor]

Updated issue 2 to be more clear.

[mbjoseph]

Hello @willskor! Thanks for opening this issue. See below for some details:

1. This is great. I am also noticing that the arr_out argument is not described in the docstring for stack_raster_tifs. https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L71-L78

If you can add a description of what the arr_out argument expects and what it does to both the spatial-raster.rst file and the earthpy/spatial.py file, that would be awesome!

2. This sounds good. I would recommend formatting the comments to match PEP 8, and changing the comments to be something like:

https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L66 changes to

# TODO: include a no data value here if provided ...

https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L252-L253 changes to

# TODO: verify colorbar works with the latest matplotlib, and is not too wide

I would just delete these two comments: https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L344-L345 The first comment is redundant with the docstring for plot_rgb, and the second comment seems to be more of an internal dialogue from the developer, that doesn't need to persist in the source code.

When you submit your pull request, please "@" me by including @mbjoseph in the pull request description. Thanks!

[willskor]

Thanks Max, will do!
One last thing. I'm also confused about this comment: https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L65
I'm not sure what it is referring to.
This is another example of some code that should probably be deleted, or made into a TODO:
https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L441

[mbjoseph]

I think you can go ahead and delete https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L65

For https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L441, it would be great if you could replace the existing comment with:

# TODO: write test case for just one color

Thanks @willskor!

[mbjoseph]

Solved by #68