Comments (5)
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.
Hey @lwasser Updated my proposed changes with additional detail. Please let me know if this makes it clearer!
from earthpy.
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.
Pull Request created and submitted to resolve this issue
#94
from earthpy.
Closing this as the PR was merged. Thank you again @yojihigh
from earthpy.
Related Issues (20)
- main page of docs has a broken link to github HOT 2
- plot_rgb fails with stretch=True for masked array with masked NaNs HOT 1
- Issue in Docs - incorrect url is breaking CI HOT 1
- Doubt on using NDVI for Sentinel-1 images
- Issue with plotting nan values. HOT 1
- Update dependencies HOT 1
- check_crs additional testing needed
- Fix Linting tests to run both black and flake8
- Issue with downloading `et.data.get_data()` HOT 2
- `_stretch_im` not working as intended HOT 4
- overlay shapefile on raster based on raster extent
- em.pixel_flags is poorly documented HOT 1
- Update vignettes to use rioxarray
- `earthpy.plot.plot_bands` method ignores `ax` keyword argument if raster has multiple bands HOT 2
- Earthpy Compatibility with Matplotlib
- Several tests are failing HOT 7
- BadZipFile: File is not a zip file HOT 1
- Error produced when I try to run earthpy with my new environment (that includes earthpy). HOT 6
- Support APPEEARS downloads
- Custom file download location HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
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.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from earthpy.