Skip to content

Fresh up with Aqua.#149

Open
evetion wants to merge 2 commits into
masterfrom
freshn
Open

Fresh up with Aqua.#149
evetion wants to merge 2 commits into
masterfrom
freshn

Conversation

@evetion

@evetion evetion commented Jun 10, 2026

Copy link
Copy Markdown
Owner

No description provided.

Comment thread src/GeoDataFrames.jl
Comment on lines +1 to +23
"""
GeoDataFrames

Work with geospatial vector data (points, lines, polygons and their attributes)
using the familiar `DataFrame` from [DataFrames.jl](https://dataframes.juliadata.org/).

A GeoDataFrame is just a regular `DataFrame` with one or more columns of
[GeoInterface.jl](https://juliageo.org/GeoInterface.jl/) compatible geometries;
there is no dedicated type. The package provides:

- [`read`](@ref) and [`write`](@ref) for the most common vector file formats
(GeoPackage, Shapefile, GeoJSON, FlatGeobuf, GeoParquet, Arrow, ...).
- Coordinate reference system helpers such as [`setcrs!`](@ref),
[`reproject`](@ref) and [`reproject!`](@ref).
- Re-exports of `DataFrames`, `GeoInterface`, `GeometryOps` and `Extents` so that
`using GeoDataFrames` is usually all you need.

```julia
using GeoDataFrames
df = DataFrame(geometry = GeoInterface.Point.(rand(10), rand(10)), name = "test")
GeoDataFrames.write("points.gpkg", df)
```
"""

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Shouldn't this just be the readme? Harder to maintain docstrings in two places

Copy link
Copy Markdown
Owner Author

Choose a reason for hiding this comment

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

Hmm, you mean, copy that content, or do you want to do it automagically?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

IIRC Julia already does it automatically, try ?GeometryOps

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants