Skip to content

Commit

Permalink
Remove module docstrings
Browse files Browse the repository at this point in the history
Removes incompatibility between reorder-python-imports and black.
For more info check the reorder-python-imports bugtracker

asottile/reorder-python-imports#66
  • Loading branch information
pmav99 committed May 14, 2024
1 parent 3dc7d5d commit 739a8d4
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 45 deletions.
12 changes: 5 additions & 7 deletions searvey/coops.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
"""
interface with the U.S. National Oceanic and Atmospheric Administration (NOAA) Center for Operational Oceanographic Products and Services (CO-OPS) API
https://api.tidesandcurrents.noaa.gov/api/prod/
"""
# Interface with the U.S. National Oceanic and Atmospheric Administration (NOAA) Center for Operational Oceanographic Products and Services (CO-OPS) API
# https://api.tidesandcurrents.noaa.gov/api/prod/
from __future__ import annotations

import json
Expand Down Expand Up @@ -779,9 +777,9 @@ def coops_stations(station_status: StationStatus | None = None) -> GeoDataFrame:

active_stations = dataframes[StationStatus.ACTIVE]
discontinued_stations = dataframes[StationStatus.DISCONTINUED]
discontinued_stations.loc[
discontinued_stations.index.isin(active_stations.index), "status"
] = StationStatus.ACTIVE.value
discontinued_stations.loc[discontinued_stations.index.isin(active_stations.index), "status"] = (
StationStatus.ACTIVE.value
)

stations = pandas.concat(
(
Expand Down
6 changes: 2 additions & 4 deletions searvey/critech.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
"""
interface with the European Marine Observation and Data Network (EMODnet) API
https://erddap.emodnet-physics.eu/erddap
"""
# Interface with the European Marine Observation and Data Network (EMODnet) API
# https://erddap.emodnet-physics.eu/erddap
import datetime
from typing import Optional

Expand Down
22 changes: 9 additions & 13 deletions searvey/ioc.py
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
"""
For the IOC stations we parse their website_.
:: _website: http://www.ioc-sealevelmonitoring.org/list.php?showall=all
This page contains 3 tables:
- ``general``
- ``contacts``
- ``performance``
We parse all 3 of them and we merge them.
"""
# For the IOC stations we parse their website: http://www.ioc-sealevelmonitoring.org/list.php?showall=all
#
# This page contains 3 tables:
#
# - ``general``
# - ``contacts``
# - ``performance``
#
# We parse all 3 of them and we merge them.
from __future__ import annotations

import functools
Expand Down
3 changes: 0 additions & 3 deletions searvey/multi.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
"""
Helpers for multi processing/threading
"""
from __future__ import annotations

import logging
Expand Down
6 changes: 2 additions & 4 deletions searvey/uhslc.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
"""
interface with the University of Hawai'i at Manoa School of Ocean and Earth Science and Technology (SOEST) Sea Level Center (UHSLC) API
https://uhslc.soest.hawaii.edu/erddap
"""
# Interface with the University of Hawai'i at Manoa School of Ocean and Earth Science and Technology (SOEST) Sea Level Center (UHSLC) API
# https://uhslc.soest.hawaii.edu/erddap
import datetime
from typing import Optional

Expand Down
19 changes: 5 additions & 14 deletions searvey/usgs.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
"""
_`dataretrieval` package developed by USGS is used for the USGS stations
:: _`dataretrieval`: https://usgs-python.github.io/dataretrieval/
This pacakge is a think wrapper around NWIS _REST API:
:: _REST: https://waterservices.usgs.gov/rest/
We take the return values from `dataretrieval` to be the original data
"""

# The `dataretrieval` package developed by USGS is used for the USGS stations: https://usgs-python.github.io/dataretrieval/
# This package is a thin wrapper around NWIS _REST API: https://waterservices.usgs.gov/rest/
# We assume that the return values from `dataretrieval` to be the original data
from __future__ import annotations

import datetime
Expand Down Expand Up @@ -55,7 +46,7 @@
USGS_OUTPUT_OF_INTEREST = (
"elevation", # Overlaps some of the specific codes below
"flow rate", # Overlaps some of the specific codes below
"00065", # Gage height, feet
"00065", # Gauge height, feet
"62614", # Lake or reservoir water surface elevation above NGVD 1929, feet
"62615", # Lake or reservoir water surface elevation above NAVD 1988, feet
"62620", # Estuary or ocean water surface elevation above NAVD 1988, feet
Expand Down Expand Up @@ -364,7 +355,7 @@ def get_usgs_data(
for result in results:
if result.result is None:
# When the `get_iv` call on station results in exception
# in `data_retrieval` due to non-existant data
# in `data_retrieval` due to non-existent data
continue

ds = _get_dataset_from_query_results(result.result, usgs_metadata)
Expand Down

0 comments on commit 739a8d4

Please sign in to comment.