GithubHelp home page GithubHelp logo

(1) Update docstring for cols variable in spatial.py/plot_bands f(x) for spelling and default value and (2) Update formatting of variables in plot_rgb and plot_bands functions. about earthpy HOT 5 CLOSED

earthlab avatar earthlab commented on June 8, 2024
(1) Update docstring for cols variable in spatial.py/plot_bands f(x) for spelling and default value and (2) Update formatting of variables in plot_rgb and plot_bands functions.

from earthpy.

Comments (5)

lwasser avatar lwasser commented on June 8, 2024

Hey @yojihigh . thank you for this issue. Just a note that you can link to a line of code like this:
https://github.com/earthlab/earthpy/blob/master/earthpy/spatial.py#L290 this is valuable especially given often the code changes as pull requests are merged

Your issue is a bit unclear. Given there are other people updating docstrings for functions in spatial.py can you kindly specify 2 functions that you'd like to update? if that is what you'd like to do.

We are asking people to follow the rasterio function documentation format for each function.
See example here

rasterio formats functions as follows

"""Display a raster or raster band using matplotlib.
     Text here if needed to describe the function

    Parameters
    ----------
    source : array or dataset object opened in 'r' mode or Band or tuple(dataset, bidx)
        If Band or tuple (dataset, bidx), display the selected band.
        If raster dataset display the rgb image
        as defined in the colorinterp metadata, or default to first band.
    with_bounds : bool (opt)
        Whether to change the image extent to the spatial bounds of the image,
        rather than pixel coordinates. Only works when source is....

Please have a look and ping me when you have a more specific update proposal! i just want to avoid merge conflicts on these pull requests.

from earthpy.

yojihigh avatar yojihigh commented on June 8, 2024

Hey @lwasser Updated my proposed changes with additional detail. Please let me know if this makes it clearer!

from earthpy.

lwasser avatar lwasser commented on June 8, 2024

hey @yojihigh this is looking very good! please go ahead and submit your PR! please be sure however to UPDATE YOUR FORK first because there have been a lot of changes today! When you submit your PR please ping me for a review. I suggest you try to do this TONIGHT!!

from earthpy.

yojihigh avatar yojihigh commented on June 8, 2024

Pull Request created and submitted to resolve this issue
#94

from earthpy.

lwasser avatar lwasser commented on June 8, 2024

Closing this as the PR was merged. Thank you again @yojihigh

from earthpy.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.