Skip to content

Commit

Permalink
Calling the wrong docstring lolz
Browse files Browse the repository at this point in the history
  • Loading branch information
natgeo-wong committed Feb 14, 2025
1 parent 6aaab4b commit 0c83096
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 7 deletions.
5 changes: 1 addition & 4 deletions docs/src/api/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,6 @@ deleteGeoRegions
## Handling custom lists of GeoRegions.jl

```@docs
tableGeoRegions(
fname :: AbstractString
)
readGeoRegions
loadGeoRegions
addGeoRegions
```
4 changes: 2 additions & 2 deletions docs/src/georegions.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ Work is currently in progress to determine how best to include multiple shapes i
Previous versions of GeoRegions.jl used to differentiate between Rectilinear (`RectRegion`) and Polygonal (`PolyRegion`) Types of GeoRegions. This is no longer supported in ≥v8.

```@docs
GeoRegion.GeoRegion
GeoRegions.GeoRegion
```

## The `Geometry` Type

All `GeoRegion`s are defined based on a `Geometry` struct type that contains information on the geometry of a GeoRegion.

```@docs
GeoRegion.Geometry
GeoRegions.Geometry
```

GeoRegions.jl extracts the `Polygon` and `Vector{Point}` information from this `Geometry` type and use the functionalities of [GeometryOps.jl](https://github.com/JuliaGeo/GeometryOps.jl) to perform checks on polygons.
2 changes: 1 addition & 1 deletion docs/src/tutorials/isequal.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ And we perform the tests with `isequal()`
```@example equivalence
isequal(geo,geo2), # true, name is not a factor in considering equivalence
isequal(geo,geo3), # false, different ID
isequal(geo,geo4) # false, different pID
isequal(geo,geo4), # false, different pID
isequal(geo,geo5) # true, shape is same even if shifted by 360
```

Expand Down

0 comments on commit 0c83096

Please sign in to comment.