Skip to content

Commit e7ed7c2

Browse files
committed
docs: correct lint formatting errors
1 parent 789b427 commit e7ed7c2

File tree

3 files changed

+42
-22
lines changed

3 files changed

+42
-22
lines changed

docs/epidatpy.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
epidatpy Reference
2-
================
2+
==================
33

44
.. toctree::
55
:maxdepth: 4
@@ -13,7 +13,7 @@ epidatpy.request module
1313
:show-inheritance:
1414

1515
epidatpy._endpoints module
16-
-----------------------
16+
--------------------------
1717

1818
.. automodule:: epidatpy._endpoints
1919
:members:

docs/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Note that for the time being, the private endpoints (i.e. those prefixed with
4545
``pvt``) will require additional permissions (contact us for more information).
4646

4747
Documentation Contents
48-
===============
48+
======================
4949

5050
.. toctree::
5151
:maxdepth: 1

epidatpy/_endpoints.py

Lines changed: 39 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,8 @@ def pub_covid_hosp_facility(
172172
hospital_pks : StringParam
173173
Unique identifiers for hospitals of interest. Supports a single string or a sequence of strings.
174174
collection_weeks : EpiRangeParam
175-
Weekly data collection periods to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
175+
Weekly data collection periods to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all
176+
("*") weeks.
176177
Note: This parameter expects dates in YYYY-MM-DD or YYYYMMDD format.
177178
If provided as ``Week``, they will be converted to the starting day of the week.
178179
publication_dates : EpiRangeParam, optional
@@ -612,7 +613,8 @@ def pub_delphi(self, system: str, epiweek: Union[int, str]) -> CALL_TYPE:
612613
----------
613614
system : str
614615
The name of the forecast system.
615-
See `Forecasting Systems <https://cmu-delphi.github.io/delphi-epidata/api/delphi.html#forecasting-systems>`_.
616+
See `Forecasting Systems
617+
<https://cmu-delphi.github.io/delphi-epidata/api/delphi.html#forecasting-systems>`_.
616618
epiweek : Union[int, str]
617619
Epiweek to fetch. Does not support multiple dates.
618620
Make separate calls to fetch data for multiple epiweeks.
@@ -637,7 +639,8 @@ def pub_dengue_nowcast(self, locations: StringParam, epiweeks: EpiRangeParam = "
637639
----------
638640
locations : StringParam
639641
Geographic locations to return. Supports a single string or a sequence of strings.
640-
See `Countries and Territories in the Americas <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#countries-and-territories-in-the-americas>`__.
642+
See `Countries and Territories in the Americas
643+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#countries-and-territories-in-the-americas>`__.
641644
epiweeks : EpiRangeParam
642645
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
643646
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -673,10 +676,12 @@ def pvt_dengue_sensors(
673676
Private API key.
674677
names : StringParam
675678
Sensor names to fetch.
676-
See `Dengue Sensors Indicators <https://cmu-delphi.github.io/delphi-epidata/api/dengue_sensors.html#indicators>`__.
679+
See `Dengue Sensors Indicators
680+
<https://cmu-delphi.github.io/delphi-epidata/api/dengue_sensors.html#indicators>`__.
677681
locations : StringParam
678682
List of countries in the Americas to fetch.
679-
See `Countries and Territories in the Americas <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#countries-and-teritories-in-the-americas>`_.
683+
See `Countries and Territories in the Americas
684+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#countries-and-teritories-in-the-americas>`_.
680685
epiweeks : EpiRangeParam
681686
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
682687
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -718,7 +723,8 @@ def pub_ecdc_ili(
718723
----------
719724
regions : StringParam
720725
List of European countries to fetch.
721-
See `European Countries <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#european-countries>`_.
726+
See `European Countries
727+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#european-countries>`_.
722728
epiweeks : EpiRangeParam
723729
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
724730
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -768,7 +774,8 @@ def pub_flusurv(
768774
----------
769775
locations : StringParam
770776
List of locations to fetch.
771-
See `FluSurv Locations <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#flusurv-locations>`_.
777+
See `FluSurv Locations
778+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#flusurv-locations>`_.
772779
epiweeks : EpiRangeParam
773780
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
774781
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -846,7 +853,8 @@ def pub_fluview_clinical(
846853
----------
847854
regions : StringParam
848855
List of regions to fetch.
849-
See `US Regions and States <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-regions-and-states>`__.
856+
See `US Regions and States
857+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-regions-and-states>`__.
850858
epiweeks : EpiRangeParam, default "*"
851859
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
852860
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -917,8 +925,10 @@ def pub_fluview(
917925
----------
918926
regions : StringParam
919927
List of regions to fetch.
920-
See `US Regions and States <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-regions-and-states>`__
921-
and `FluView Cities <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#fluview-cities>`__.
928+
See `US Regions and States
929+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-regions-and-states>`__
930+
and `FluView Cities
931+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#fluview-cities>`__.
922932
epiweeks : EpiRangeParam
923933
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
924934
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -979,7 +989,8 @@ def pub_gft(self, locations: StringParam, epiweeks: EpiRangeParam = "*") -> CALL
979989
----------
980990
locations : StringParam
981991
List of locations to fetch.
982-
See `Geographic Codes <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-states>`__.
992+
See `Geographic Codes
993+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-states>`__.
983994
epiweeks : EpiRangeParam
984995
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
985996
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -1016,7 +1027,8 @@ def pvt_ght(
10161027
Private API key.
10171028
locations : StringParam
10181029
List of locations to fetch.
1019-
See `Geographic Codes <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-states>`__.
1030+
See `Geographic Codes
1031+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-states>`__.
10201032
epiweeks : EpiRangeParam, default "*"
10211033
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
10221034
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -1064,7 +1076,8 @@ def pub_kcdc_ili(
10641076
----------
10651077
regions : StringParam
10661078
List of regions to fetch.
1067-
See `Republic of Korea <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#republic-of-korea>`_.
1079+
See `Republic of Korea
1080+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#republic-of-korea>`__.
10681081
epiweeks : EpiRangeParam
10691082
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
10701083
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -1132,7 +1145,8 @@ def pub_nidss_dengue(self, locations: StringParam, epiweeks: EpiRangeParam = "*"
11321145
----------
11331146
locations : StringParam
11341147
List of Taiwan locations to fetch.
1135-
See `Taiwan Locations <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#nidss>`_.
1148+
See `Taiwan Locations
1149+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#nidss>`_.
11361150
epiweeks : EpiRangeParam
11371151
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
11381152
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -1165,7 +1179,8 @@ def pub_nidss_flu(
11651179
----------
11661180
regions : StringParam
11671181
List of Taiwan locations to fetch.
1168-
See `Taiwan Locations <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#nidss>`_.
1182+
See `Taiwan Locations
1183+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#nidss>`_.
11691184
epiweeks : EpiRangeParam
11701185
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
11711186
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -1237,7 +1252,8 @@ def pub_nowcast(self, locations: StringParam, epiweeks: EpiRangeParam = "*") ->
12371252
----------
12381253
locations : StringParam
12391254
List of locations to fetch.
1240-
See `Geographic Codes <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-states>`__.
1255+
See `Geographic Codes
1256+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-states>`__.
12411257
epiweeks : EpiRangeParam
12421258
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
12431259
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -1271,7 +1287,9 @@ def pub_paho_dengue(
12711287
----------
12721288
regions : StringParam
12731289
List of American countries and territories to fetch.
1274-
See `Countries and Territories in the Americas <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#countries-and-territories-in-the-americas>`__.
1290+
See `Countries and Territories in the Americas
1291+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#countries-and-territories-in-the-americas>`__.
1292+
12751293
epiweeks : EpiRangeParam
12761294
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
12771295
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -1319,7 +1337,8 @@ def pvt_quidel(self, auth: str, locations: StringParam, epiweeks: EpiRangeParam
13191337
Private API key.
13201338
locations : StringParam
13211339
List of locations to fetch.
1322-
See `Geographic Codes <https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-states>`__.
1340+
See `Geographic Codes
1341+
<https://cmu-delphi.github.io/delphi-epidata/api/geographic_codes.html#us-states>`__.
13231342
epiweeks : EpiRangeParam
13241343
Epiweeks to fetch. Supports :class:`~epidatpy.EpiRange` and defaults to all ("*") weeks.
13251344
Format as ``epirange(startweek, endweek)``, where startweek and endweek are of the form
@@ -1458,7 +1477,8 @@ def pub_wiki(
14581477
----------
14591478
articles : StringParam
14601479
The Wikipedia article(s) to fetch. Supports a single string or a sequence of strings.
1461-
See `Available Articles <https://cmu-delphi.github.io/delphi-epidata/api/wiki.html#available-articles>`_.
1480+
See `Available Articles
1481+
<https://cmu-delphi.github.io/delphi-epidata/api/wiki.html#available-articles>`_.
14621482
time_type : Literal["day", "week"]
14631483
The temporal resolution to use ("day" or "week").
14641484
time_values : EpiRangeParam, default "*"

0 commit comments

Comments
 (0)