Merge pull request #373 from cmu-delphi/sg-docs

Update safegraph docstrings to pass pydocstyle

Author: krivard

safegraph/delphi_safegraph/process.py

@@ -18,18 +18,19 @@
 
 
 def validate(df):
-    """Confirms that a data frame has only one date."""
+    """Confirm that a data frame has only one date."""
     timestamps = df['date_range_start'].apply(date_from_timestamp)
     assert len(timestamps.unique()) == 1
 
 
 def date_from_timestamp(timestamp) -> datetime.date:
-    """Extracts the date from a timestamp beginning with {YYYY}-{MM}-{DD}T."""
+    """Extract the date from a timestamp beginning with {YYYY}-{MM}-{DD}T."""
     return datetime.date.fromisoformat(timestamp.split('T')[0])
 
 
 def files_in_past_week(current_filename) -> List[str]:
-    """Constructs file paths from previous 6 days.
+    """Construct file paths from previous 6 days.
+
     Parameters
     ----------
     current_filename: str
@@ -51,12 +52,13 @@ def files_in_past_week(current_filename) -> List[str]:
 
 
 def add_suffix(signals, suffix):
-    """Adds `suffix` to every element of `signals`."""
+    """Add `suffix` to every element of `signals`."""
     return [s + suffix for s in signals]
 
 
 def construct_signals(cbg_df, signal_names):
     """Construct Census-block level signals.
+
     In its current form, we prepare the following signals in addition to those
     already available in raw form from Safegraph:
     - completely_home_prop, defined as:
@@ -80,7 +82,6 @@ def construct_signals(cbg_df, signal_names):
         Dataframe with columns: timestamp, county_fips, and
         {each signal described above}.
     """
-
     # Preparation
     cbg_df['county_fips'] = (cbg_df['origin_census_block_group'] // MOD).apply(
         lambda x: f'{int(x):05d}')
@@ -105,6 +106,7 @@ def construct_signals(cbg_df, signal_names):
 
 def aggregate(df, signal_names, geo_resolution='county'):
     """Aggregate signals to appropriate resolution and produce standard errors.
+
     Parameters
     ----------
     df: pd.DataFrame
@@ -156,9 +158,10 @@ def process_window(df_list: List[pd.DataFrame],
                    signal_names: List[str],
                    geo_resolutions: List[str],
                    export_dir: str):
-    """Processes a list of input census block group-level data frames as a
-    single data set and exports it.  Assumes each data frame has _only_ one
-    date of data.
+    """Process a list of input census block group-level data frames as a single data set and export.
+
+    Assumes each data frame has _only_ one date of data.
+
     Parameters
     ----------
     cbg_df: pd.DataFrame
@@ -200,8 +203,8 @@ def process(filenames: List[str],
             wip_signal,
             geo_resolutions: List[str],
             export_dir: str):
-    """Creates and exports signals corresponding both to a single day as well
-    as averaged over the previous week.
+    """Create and exports signals corresponding both single day and averaged over the previous week.
+
     Parameters
     ----------
     current_filename: List[str]

safegraph/delphi_safegraph/run.py

@@ -1,4 +1,5 @@
 """Functions to call when running the function.
+
 This module should contain a function called `run_module`, that is executed
 when the module is run with `python -m MODULE_NAME`.
 """
@@ -14,7 +15,7 @@
 
 
 def run_module():
-    """Creates the Safegraph indicator."""
+    """Create the Safegraph indicator."""
     params = read_params()
 
     # Place to write output files.