apply(#18): add note to CoordinateReferenceSystems about NL and modif…

…y figure according to PR #18 comments
cemsbv · Jun 10, 2024 · 11184ff · 11184ff
1 parent 214c513
commit 11184ff
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 7 deletions.
diff --git a/docs/tree/figures/settlement_rod.png b/docs/tree/figures/settlement_rod.png
diff --git a/docs/tree/reference.rst b/docs/tree/reference.rst
@@ -51,7 +51,7 @@ Measurement Device
 
     .. automethod:: __init__
 
-.. _measurementProject:
+.. _project:
 
 Project
 -------
@@ -63,3 +63,14 @@ Project
 
     .. automethod:: __init__
 
+CoordinateReferenceSystems
+--------------------------
+
+.. _coordinateReferenceSystems:
+
+.. autoclass:: baec.coordinates.CoordinateReferenceSystems
+    :members:
+    :inherited-members:
+    :member-order: bysource
+
+    .. automethod:: __init__
diff --git a/src/baec/coordinates.py b/src/baec/coordinates.py
@@ -14,7 +14,7 @@ def __init__(self, horizontal: pyproj.CRS, vertical: pyproj.CRS) -> None:
         """
         Initializes a CoordinateReferenceSystems object.
 
-        Parameters:
+        Parameters
         ----------
         horizontal : pyproj.CRS
             The coordinate reference system of the X and Y-coordinates.
@@ -42,18 +42,20 @@ def __init__(self, horizontal: pyproj.CRS, vertical: pyproj.CRS) -> None:
     def from_epsg(cls, horizontal: int, vertical: int) -> CoordinateReferenceSystems:
         """
         Creates a CoordinateReferenceSystems object from the EPSG codes of the horizontal and vertical CRS.
-Notes:
------------
-If your settlement rod is located in the Netherlands the horizontal coordinate reference systems is likely `28992` (Amersfoort / RD New) and the vertical `5709` (NAP height). To combine use `7415` (Amersfoort / RD New + NAP height).
 
-        Parameters:
+        Note
+        ----
+        If your settlement rod is located in the Netherlands the horizontal coordinate reference systems is likely `28992`
+        (Amersfoort / RD New) and the vertical `5709` (NAP height). To combine use `7415` (Amersfoort / RD New + NAP height).
+
+        Parameters
         ----------
         horizontal : int
             The EPSG code of the horizontal CRS.
         vertical : int
             The EPSG code of the vertical CRS.
 
-        Returns:
+        Returns
         -------
         CoordinateReferenceSystems
             A CoordinateReferenceSystems object with the horizontal and vertical CRS.