Simplifies code in Data Providers and enhances API reference

qiskit_finance/data_providers/_base_data_provider.py

@@ -50,9 +50,10 @@ class StockMarket(Enum):
 
 
 class BaseDataProvider(ABC):
-    """The abstract base class for data_provider modules within Qiskit Finance module.
+    """The abstract base class for :code:`data_provider` modules within Qiskit Finance.
 
-    To create add-on data_provider module subclass the BaseDataProvider class in this module.
+    Creates :code:`data_provider` module subclasses based on the :code:`BaseDataProvider`
+    abstract class in this module.
     Doing so requires that the required driver interface is implemented.
 
     To use the subclasses, please see
@@ -74,11 +75,8 @@ def run(self) -> None:
         """
         Abstract method to load data.
 
-        Method responsible for loading data. Subclasses of `BaseDataProvider`
+        Method responsible for loading data. Subclasses of :code:`BaseDataProvider`
         must implement this method to load data from a specific data source.
-
-        Raises:
-            NotImplementedError: This method must be implemented in a subclass.
         """
         pass
 
@@ -92,7 +90,7 @@ def _check_data_loaded(self) -> None:
         """
         if not hasattr(self, "_data") or not self._data:
             raise QiskitFinanceError(
-                "No data loaded yet. Please run the method :code:`run()` first to load the data."
+                "No data loaded yet. Please run the method `run()` first to load the data."
             )
 
     # it does not have to be overridden in non-abstract derived classes.
@@ -230,7 +228,7 @@ def get_similarity_matrix(self) -> np.ndarray:
     # it does not have to be overridden in non-abstract derived classes.
     def get_coordinates(self) -> tuple[np.ndarray, np.ndarray]:
         """
-        Generates random coordinates for visualisation purposes.
+        Generates random coordinates for visualization purposes.
 
         Returns random coordinates for visualization purposes. These coordinates
         can be used to plot assets in a two-dimensional space, facilitating visualization

qiskit_finance/data_providers/exchange_data_provider.py

@@ -62,7 +62,7 @@ def __init__(
                 Defaults to January 30th, 2016.
 
         Raises:
-            QiskitFinanceError: provider doesn't support given stock market
+            QiskitFinanceError: provider doesn't support given stock market.
         """
         super().__init__()
 
@@ -88,7 +88,7 @@ def __init__(
 
     def run(self) -> None:
         """
-        Loads data, thus enabling get_similarity_matrix and get_covariance_matrix
+        Loads data, thus enabling :code:`get_similarity_matrix` and :code:`get_covariance_matrix`
         methods in the base class.
         """
         nasdaqdatalink.ApiConfig.api_key = self._token