Add RST documentation to spatial-raster.rst for the functions plot_rgb() and hist() located in spatial.py about earthpy

[lwasser]

Hi @cstuart7 these items have been covered in this issue and this pull request

Please pay close attention to existing PR's and issues and update this issue accordingly with 2 unique changes.

[cstuart7]

@lwasser Corrected one of my changes to not duplicate the other issue that you identified.

[lwasser]

Hi Carmela, Please read the assignment closely – posted in canvas. Then find 2 changes that each fit into the guidelines below. There is no vector module in the earthpy package so this proposed change is not correct but also does not follow the guidelines below. There is however a file reserved for documenting functions related to vector data which is the file you mention but you need to work on documentation for a function in that file! ``` * Add documentation for one earthpy function to an .rst file in the docs dir (Links to an external site.)Links to an external site.<https://github.com/earthlab/earthpy/tree/master/docs>. This file will in turn add to the earthpy documentation (Links to an external site.)Links to an external site.<https://earthpy.readthedocs.io/en/latest/>. For example, add documentation for crop_image(). * Update module code (a single .py file) to meet PEP 8 guidelines. * Update function docstring documentation given typos, or missing function arguments. * Following rasterio documentation, each function argument should be documented using the prescribed docstring syntax * Update / Cleanup and remove commented out code and extraneous comments from a function. ```

[cstuart7]

@lwasser Ok, re-did my issue to be better suited to requirements in Canvas.

[lwasser]

Thank you @cstuart7 . This is a good start.

One point to consider when you submit your pr:

The ``plot_rgb`` function plots each layer in a raster stack converted into a numpy array for quick visualization.

The plot_rgb function actually takes a 3 dimensional numpy array that contains image data and plots the 3 bands together to create a composite image. When you submit your PR - please review the lessons to recall what the functions do. The documentation should be very user friendly !

Please go ahead and work on your PR. When you are happy with it, ping me using @lwasser and reference this issue as well via a link. Thank you!

[lwasser]

closing this as the PR was merged. Thank you again @cstuart7