Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve docstring of make_xarray_grid #399

Merged
merged 2 commits into from
Dec 9, 2022
Merged

Improve docstring of make_xarray_grid #399

merged 2 commits into from
Dec 9, 2022

Conversation

santisoler
Copy link
Member

@santisoler santisoler commented Nov 30, 2022 •
edited
Loading

Make it clearer that the verde.make_xarray_grid function expects 2d arrays as
inputs and it does not perform any interpolation or gridding. Add an admonition
pointing users to interpolator classes.

These changes were triggered by the https://github.com/orgs/fatiando/discussions/84 discussion in our forum.

@santisoler santisoler added the documentation Improvements or additions to documentation label Nov 30, 2022
@santisoler santisoler requested a review from leouieda November 30, 2022 17:54
leouieda
leouieda approved these changes Dec 9, 2022
View reviewed changes
Copy link
Member

@leouieda leouieda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @santisoler! That's much better

@leouieda leouieda merged commit cafa15d into main Dec 9, 2022
@leouieda leouieda deleted the make_xarray_docs branch December 9, 2022 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@leouieda leouieda leouieda approved these changes

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@santisoler @leouieda