From 2998bd345e59f2926e781817f831eacc617cfbd1 Mon Sep 17 00:00:00 2001 From: Bousquin Date: Fri, 29 Sep 2023 21:41:51 -0500 Subject: [PATCH] Resolve new doc warnings/spelling that resulted from review fixes. --- docs/source/conf.py | 1 - harmonize_wq/clean.py | 4 ++-- harmonize_wq/domains.py | 2 +- harmonize_wq/location.py | 2 +- harmonize_wq/visualize.py | 2 +- harmonize_wq/wq_data.py | 4 ++-- harmonize_wq/wrangle.py | 2 +- 7 files changed, 8 insertions(+), 9 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 7347951..bf64351 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -42,7 +42,6 @@ "sphinx.ext.coverage", "sphinx.ext.napoleon", "sphinx.ext.intersphinx", - 'sphinx.ext.autosectionlabel', "sphinxcontrib.spelling", ] diff --git a/harmonize_wq/clean.py b/harmonize_wq/clean.py index 9feddaf..344f8b1 100644 --- a/harmonize_wq/clean.py +++ b/harmonize_wq/clean.py @@ -198,8 +198,8 @@ def methods_check(df_in, char_val, methods=None): def wet_dry_checks(df_in, mask=None): """Fix suspected errors in 'ActivityMediaName' column. - Uses the 'ResultWeightBasisText' and 'ResultSampleFractionText' columns to swicth if the media is - wet/dry where appropriate. + Uses the 'ResultWeightBasisText' and 'ResultSampleFractionText' columns to + switch if the media is wet/dry where appropriate. Parameters ---------- diff --git a/harmonize_wq/domains.py b/harmonize_wq/domains.py index 8925a10..7fd5bb4 100644 --- a/harmonize_wq/domains.py +++ b/harmonize_wq/domains.py @@ -542,7 +542,7 @@ def xy_datum(): ----- source WQP: HorizontalCoordinateReferenceSystemDatum_CSV.zip - Anything not in dict will be nan, and non-integer EPSG will be missing: + Anything not in dict will be NaN, and non-integer EPSG will be missing: "OTHER": {"Description": 'Other', "EPSG": nan}, "UNKWN": {"Description": 'Unknown', "EPSG": nan} diff --git a/harmonize_wq/location.py b/harmonize_wq/location.py index 7422e88..5ff78d2 100644 --- a/harmonize_wq/location.py +++ b/harmonize_wq/location.py @@ -18,7 +18,7 @@ def infer_CRS(df_in, crs_col='HorizontalCoordinateReferenceSystemDatumName'): """Replace missing or unrecognized Coordinate Reference System (CRS). - Replaces with desired CRS and notes it was mising in 'QA_flag' column. + Replaces with desired CRS and notes it was missing in 'QA_flag' column. Parameters ---------- diff --git a/harmonize_wq/visualize.py b/harmonize_wq/visualize.py index b648338..34cba37 100644 --- a/harmonize_wq/visualize.py +++ b/harmonize_wq/visualize.py @@ -75,7 +75,7 @@ def map_counts(df_in, gdf, col=None): GeoDataFrame with monitoring locations. col : str, optional Column in df_in to aggregate results to in addition to location. - The default is None, where results are only aggregated on locaion. + The default is None, where results are only aggregated on location. Returns ------- diff --git a/harmonize_wq/wq_data.py b/harmonize_wq/wq_data.py index f3ae091..78e37e5 100644 --- a/harmonize_wq/wq_data.py +++ b/harmonize_wq/wq_data.py @@ -35,7 +35,7 @@ class WQCharData(): pint unit registry, initially standard unit registry. units : str Units all results in out_col column will be converted into. - Default units are returned from :func:`domains.OUT_UNITS`[out_col]. + Default units are returned from :func:`domains.OUT_UNITS` [out_col]. Examples -------- @@ -261,7 +261,7 @@ def check_units(self, flag_col=None): Parameters ---------- flag_col : str, optional - Column to reference in srting for 'QA_flags'. + Column to reference in string for 'QA_flags'. The default None uses WQCharData.col.unit_out attribute. Returns diff --git a/harmonize_wq/wrangle.py b/harmonize_wq/wrangle.py index 35b0b57..e603d50 100644 --- a/harmonize_wq/wrangle.py +++ b/harmonize_wq/wrangle.py @@ -78,7 +78,7 @@ def split_col(df_in, result_col='QA_flag', col_prefix='QA'): Examples -------- See any of the 'Simple' notebooks found in - `demo s`_ for + `demos `_ for examples of how this function is used to split the QA column into multiple characteristic specific QA columns.