Skip to content

Commit 5f0ec60

Browse files
committed
Align docstring args with function signatures
1 parent cf80d56 commit 5f0ec60

File tree

1 file changed

+14
-13
lines changed

1 file changed

+14
-13
lines changed

src/bedrock_ge/gi/ags3.py

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -26,14 +26,13 @@ def ags3_to_dfs(
2626
make the rest of the code more generic.
2727
2828
Args:
29-
source (str | Path | IO[str] | IO[bytes] | bytes): The AGS 3 file (str or Path)
30-
or a file-like object that represents the AGS 3 file.
31-
encoding (str): Encoding of file or object.
29+
source: The AGS 3 file (str or Path) or a file-like object that represents the AGS 3 file.
30+
encoding: Encoding of the text file or bytes stream.
3231
3332
Returns:
34-
dict[str, pd.DataFrame]: A dictionary of pandas DataFrames, i.e. a database,
35-
where each key is an AGS 3 group, and the corresponding value is
36-
a pandas DataFrame containing the data for that group.
33+
A dictionary of pandas DataFrames, i.e. a database, where each key is
34+
an AGS 3 group, and the corresponding value is a pandas DataFrame
35+
containing the data for that group.
3736
"""
3837
# Initialize dictionary and variables used in the AGS 3 read loop
3938
ags3_dfs = {}
@@ -134,16 +133,18 @@ def ags3_to_brgi_db_mapping(
134133
"""Map AGS 3 data to the Bedrock GI data model.
135134
136135
Args:
137-
ags3_db (dict[str, pd.DataFrame]): A dictionary of pandas DataFrames, i.e. database,
138-
where each key is an AGS 3 group, and the corresponding value is
139-
a pandas DataFrame containing the data for that group.
140-
projected_crs (CRS): Projected coordinate reference system (CRS).
141-
vertical_crs (CRS, optional): Vertical CRS. Defaults to EGM2008 height, EPSG:3855
136+
source: The AGS 3 file (str or Path) or a file-like object that represents the AGS 3 file.
137+
projected_crs: Projected Coordinate Reference System (CRS). For example:
138+
- OSGB36 / British National Grid: `pyproj.CRS("EPSG:27700")`
139+
- Hong Kong 1980 Grid System: `pyproj.CRS("EPSG:2326")`
140+
vertical_crs: Vertical CRS. Defaults to EGM2008 height, EPSG:3855,
142141
which measures the orthometric height w.r.t. the Earth Gravitational Model 2008.
143-
encoding (str): Encoding of the text file or bytes stream.
142+
- Ordnance Datum Newlyn (ODN) Height: `pyproj.CRS("EPSG:5701")`
143+
- Hong Kong Principle Datum (HKPD) Height: `pyproj.CRS("EPSG:5738")`
144+
encoding: Encoding of the text file or bytes stream.
144145
145146
Returns:
146-
BedrockGIDatabaseMapping: Object that maps AGS 3 data to Bedrock GI data model.
147+
Object that maps AGS 3 data to Bedrock GI data model.
147148
"""
148149
ags3_dfs = ags3_to_dfs(source, encoding)
149150

0 commit comments

Comments
 (0)