Skip to content

Commit 308c90b

Browse files
author
Taher Chegini
committed
DOC: Add methods manually to classes that inheret from AGRBase. [skip ci]
1 parent 2185a0a commit 308c90b

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

pynhd/pynhd.py

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,16 @@ class NHD(AGRBase):
6262
outfields : str or list, optional
6363
Target field name(s), default to "*" i.e., all the fields.
6464
crs : str, int, or pyproj.CRS, optional
65-
Target spatial reference, default to ``EPSG:4326``
65+
Target spatial reference, default to ``EPSG:4326``.
66+
67+
Methods
68+
-------
69+
bygeom(geom, geo_crs=4326, sql_clause="", distance=None, return_m=False, return_geom=True)
70+
Get features within a geometry that can be combined with a SQL where clause.
71+
byids(field, fids, return_m=False, return_geom=True)
72+
Get features by object IDs.
73+
bysql(sql_clause, return_m=False, return_geom=True)
74+
Get features using a valid SQL 92 WHERE clause.
6675
"""
6776

6877
def __init__(
@@ -597,7 +606,16 @@ class NHDPlusHR(AGRBase):
597606
outfields : str or list, optional
598607
Target field name(s), default to "*" i.e., all the fields.
599608
crs : str, int, or pyproj.CRS, optional
600-
Target spatial reference, default to ``EPSG:4326``
609+
Target spatial reference, default to ``EPSG:4326``.
610+
611+
Methods
612+
-------
613+
bygeom(geom, geo_crs=4326, sql_clause="", distance=None, return_m=False, return_geom=True)
614+
Get features within a geometry that can be combined with a SQL where clause.
615+
byids(field, fids, return_m=False, return_geom=True)
616+
Get features by object IDs.
617+
bysql(sql_clause, return_m=False, return_geom=True)
618+
Get features using a valid SQL 92 WHERE clause.
601619
"""
602620

603621
def __init__(

0 commit comments

Comments
 (0)