Merge pull request #981 from bashtage/docs

STY: Improve style

Author: bashtage

README.md

@@ -38,7 +38,7 @@ for the latest changes in master.
 
 Using pandas datareader requires the following packages:
 
--   pandas>=1.0
+-   pandas>=1.5.3
 -   lxml
 -   requests>=2.19.0
 

docs/source/conf.py

@@ -87,7 +87,7 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = "en"
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -200,7 +200,7 @@
 
 
 # Example configuration for intersphinx: refer to the Python standard library.
-intersphinx_mapping = {"https://docs.python.org/": None}
+intersphinx_mapping = {"python": ("https://docs.python.org/3", None)}
 
 
 extlinks = {

pandas_datareader/data.py

@@ -491,7 +491,9 @@ def DataReader(
     elif data_source == "nasdaq":
         if name != "symbols":
             raise ValueError(
-                "Only the string 'symbols' is supported for Nasdaq, not {!r}".format(name)
+                "Only the string 'symbols' is supported for Nasdaq, not {!r}".format(
+                    name
+                )
             )
         return get_nasdaq_symbols(retry_count=retry_count, pause=pause)
 

pandas_datareader/iex/deep.py

@@ -85,7 +85,7 @@ def _read_lines(self, out):
         if self.sub in fmap:
             return getattr(self, fmap[self.sub])(out)
         else:
-            raise f"Invalid service specified: {self.sub}."
+            raise ValueError(f"Invalid service specified: {self.sub}.")
 
     def _read_system_event(self, out):
         # Map the response code to a string output per the API docs.

pandas_datareader/io/sdmx.py

@@ -167,9 +167,7 @@ def _get_child(element, key):
     elif len(elements) == 0:
         raise ValueError(f"Element {element.tag} contains no {key}")
     else:
-        raise ValueError(
-            f"Element {element.tag} contains multiple {key}"
-        )
+        raise ValueError(f"Element {element.tag} contains multiple {key}")
 
 
 _NAME_EN = f".//{_COMMON}Name[@{_XML}lang='en']"

pandas_datareader/nasdaq_trader.py

@@ -60,9 +60,7 @@ def _download_nasdaq_symbols(timeout):
         raise RemoteDataError("Missing expected footer. Found %r" % lines[-1])
 
     # Convert Y/N to True/False.
-    converter_map = {
-        col: _bool_converter for col, t in _TICKER_DTYPE if t is bool
-    }
+    converter_map = {col: _bool_converter for col, t in _TICKER_DTYPE if t is bool}
 
     # For pandas >= 0.20.0, the Python parser issues a warning if
     # both a converter and dtype are specified for the same column.

pandas_datareader/quandl.py

@@ -56,9 +56,7 @@ def __init__(
         chunksize=25,
         api_key=None,
     ):
-        super().__init__(
-            symbols, start, end, retry_count, pause, session, chunksize
-        )
+        super().__init__(symbols, start, end, retry_count, pause, session, chunksize)
         if api_key is None:
             api_key = os.getenv("QUANDL_API_KEY")
         if not api_key or not isinstance(api_key, str):

pandas_datareader/tests/yahoo/test_yahoo.py

@@ -71,9 +71,7 @@ def test_get_quote_comma_name(self):
             pytest.xfail(reason=XFAIL_REASON)
         assert df["longName"][0] == "Royal Gold, Inc."
 
-    @pytest.mark.skip(
-        "Unreliable test, receive partial components back for dow_jones"
-    )
+    @pytest.mark.skip("Unreliable test, receive partial components back for dow_jones")
     def test_get_components_dow_jones(self):  # pragma: no cover
         df = web.get_components_yahoo("^DJI")  # Dow Jones
         assert isinstance(df, pd.DataFrame)
@@ -87,9 +85,7 @@ def test_get_components_dax(self):  # pragma: no cover
         assert len(df) == 30
         assert df[df.name.str.contains("adidas", case=False)].index == "ADS.DE"
 
-    @pytest.mark.skip(
-        "Unreliable test, receive partial components back for nasdaq_100"
-    )
+    @pytest.mark.skip("Unreliable test, receive partial components back for nasdaq_100")
     def test_get_components_nasdaq_100(self):  # pragma: no cover
         # As of 7/12/13, the conditional will
         # return false because the link is invalid

pandas_datareader/yahoo/options.py

@@ -706,9 +706,7 @@ def _parse_url(self, url):
         """
         jd = json.loads(self._read_url_as_StringIO(url).read())
         if jd is None:  # pragma: no cover
-            raise RemoteDataError(
-                f"Parsed URL {url!r} is not a valid json object"
-            )
+            raise RemoteDataError(f"Parsed URL {url!r} is not a valid json object")
         return jd
 
     def _process_data(self, jd):