tracts20 to docs

oturns · Oct 2, 2023 · 0c559d1 · 0c559d1
1 parent c38d87f
commit 0c559d1
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 25 deletions.
diff --git a/.github/workflows/unittests.yml b/.github/workflows/unittests.yml
@@ -46,7 +46,7 @@ jobs:
 
       - name: Test geosnap
         run: |
-          pytest -v --color yes --cov geosnap --cov-append --cov-report term-missing --cov-report xml .
+          pytest -v --color yes --cov geosnap/tests --cov-append --cov-report term-missing --cov-report xml .
 
       - uses: codecov/codecov-action@v3
 

diff --git a/docs/api.rst b/docs/api.rst
@@ -41,7 +41,7 @@ available quickly with no configuration by accessing methods on the class.
     DataStore.tracts_1990
     DataStore.tracts_2000
     DataStore.tracts_2010
-
+    DataStore.tracts_2020
 
 Storing data
 '''''''''''''''

diff --git a/geosnap/_data.py b/geosnap/_data.py
@@ -433,9 +433,8 @@ def tracts_2000(self, states=None):
 
         Returns
         -------
-        pandas.DataFrame or geopandas.GeoDataFrame
-            2000 tracts as a geodataframe or as a dataframe with geometry
-            stored as well-known binary on the 'wkb' column.
+        geopandas.GeoDataFrame
+            2000 tracts as a geodataframe
 
         """
         local = pathlib.Path(self.data_dir, "tracts_2000_500k.parquet")
@@ -461,9 +460,8 @@ def tracts_2010(
 
         Returns
         -------
-        pandas.DataFrame or geopandas.GeoDataFrame
-            2010 tracts as a geodataframe or as a dataframe with geometry
-            stored as well-known binary on the 'wkb' column.
+        geopandas.GeoDataFrame
+            2010 tracts as a geodataframe
 
         """
         msg = "Streaming data from S3. Use `geosnap.io.store_census() to store the data locally for better performance"
@@ -480,7 +478,7 @@ def tracts_2020(
         self,
         states=None,
     ):
-        """Nationwide Census Tracts as drawn in 2010 (cartographic 500k).
+        """Nationwide Census Tracts as drawn in 2020 (cartographic 500k).
 
         Parameters
         ----------
@@ -489,9 +487,8 @@ def tracts_2020(
 
         Returns
         -------
-        pandas.DataFrame or geopandas.GeoDataFrame
-            2010 tracts as a geodataframe or as a dataframe with geometry
-            stored as well-known binary on the 'wkb' column.
+        geopandas.GeoDataFrame
+            2020 tracts as a geodataframe
 
         """
         msg = "Streaming data from S3. Use `geosnap.io.store_census() to store the data locally for better performance"
@@ -513,9 +510,8 @@ def msas(self):
 
         Returns
         -------
-        pandas.DataFrame or geopandas.GeoDataFrame
-            2010 MSAs as a geodataframe or as a dataframe with geometry
-            stored as well-known binary on the 'wkb' column.
+        geopandas.GeoDataFrame
+            2010 MSAs as a geodataframe
 
         """
         local = pathlib.Path(self.data_dir, "msas.parquet")
@@ -530,9 +526,8 @@ def states(self):
 
         Returns
         -------
-        pandas.DataFrame or geopandas.GeoDataFrame
-            US States as a geodataframe or as a dataframe with geometry
-            stored as well-known binary on the 'wkb' column.
+        geopandas.GeoDataFrame
+            US States as a geodataframe
 
         """
         local = pathlib.Path(self.data_dir, "states.parquet")
@@ -545,16 +540,10 @@ def states(self):
     def counties(self):
         """Nationwide counties as drawn in 2010.
 
-        Parameters
-        ----------
-        convert : bool
-            if True, return geodataframe, else return dataframe (the default is True).
-
         Returns
         -------
         geopandas.GeoDataFrame
-            2010 counties as a geodataframe or as a dataframe with geometry
-            stored as well-known binary on the 'wkb' column.
+            2010 counties as a geodataframe.
 
         """
         local = pathlib.Path(self.data_dir, "counties.parquet")