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.

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

docs: add example docstrings to geospatial methods #7959

Closed
jcrist opened this issue Jan 11, 2024 · 2 comments · Fixed by #8128
Closed

docs: add example docstrings to geospatial methods #7959

jcrist opened this issue Jan 11, 2024 · 2 comments · Fixed by #8128
Assignees
Labels
docs Documentation related issues or PRs geospatial Geospatial related functionality

Comments

@jcrist
Copy link
Member

jcrist commented Jan 11, 2024

Now that the duckdb backend supports geospatial operations, we should be able to add example docstrings on any geo method that the duckdb backend supports.

Using the dataset (or datasets) added in #7958 may be useful here.

@jcrist jcrist added docs Documentation related issues or PRs geospatial Geospatial related functionality labels Jan 11, 2024
@ncclementi
Copy link
Contributor

ncclementi commented Jan 16, 2024

I wonder, where is a good place to document this examples. At the moment the only geospatial docs we have are https://ibis-project.org/reference/expression-geospatial which contains a list of all the geospatial expressions supported, but it's kind of useless, given that most of these are backend dependent and there is no clarity on which one is which.

Is there a way we can have the duckdb-geospatial docs at the backend level?

I think it would be great if we can have under the docs specific backend (like here), a tab that says geospatial and there render all the geospatial expresions supported for that backend. Is this possible? I'm not sure if there is a way of grabbing the backend specific geospatial functions and somehow include them in the api template.

https://github.com/ibis-project/ibis/blob/main/docs/backends/_templates/api.qmd

@cpcloud I see you add it the _templates.api.qmd Do you think with it's possible to somehow have backend specific geospatial docs pulled here?

@ncclementi
Copy link
Contributor

At the moment blocked by: duckdb/duckdb-spatial#236.

@ncclementi ncclementi moved this from cooking to review in Ibis planning and roadmap Jan 30, 2024
cpcloud pushed a commit that referenced this issue Jan 31, 2024
## Description of changes
- Add docstring examples for duckdb geospatial functions

## Issues closed

Closes #7959
@github-project-automation github-project-automation bot moved this from review to done in Ibis planning and roadmap Jan 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related issues or PRs geospatial Geospatial related functionality
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants