Skip to content

Commit

Permalink
Correct method links in API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edoaltamura committed Jun 12, 2024
1 parent 1837fe3 commit 0ca7b4a
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions qiskit_finance/data_providers/_base_data_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ def get_period_return_covariance_matrix(self) -> np.ndarray:
np.ndarray: A covariance matrix between period returns of assets.
Raises:
QiskitFinanceError: If no data is loaded. Please run the method :code:`run()`
QiskitFinanceError: If no data is loaded. Please run the method :meth:`run()`
first to load the data.
"""
self._check_data_loaded()
Expand Down Expand Up @@ -209,7 +209,7 @@ def get_similarity_matrix(self) -> np.ndarray:
np.ndarray: An asset-to-asset similarity matrix.
Raises:
QiskitFinanceError: If no data is loaded. Please run the method :code:`run()`
QiskitFinanceError: If no data is loaded. Please run the method :meth:`run()`
first to load the data.
"""
self._check_data_loaded()
Expand Down
2 changes: 1 addition & 1 deletion qiskit_finance/data_providers/data_on_demand_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ def __init__(
verify (str | bool | None): If verify is `None`, runs the certificate verification (default);
if this is :code:`False`, no certificates will be checked; if this is a :code:`str`,
it should be pointing
to a certificate for the HTTPS connection to NASDAQ (:code:`dataondemand.nasdaq.com`),
to a certificate for the HTTPS connection to NASDAQ (www.dataondemand.nasdaq.com),
either in the form of a :code:`CA_BUNDLE` file or a directory wherein to look.
"""
super().__init__()
Expand Down
2 changes: 1 addition & 1 deletion qiskit_finance/data_providers/exchange_data_provider.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ def __init__(

def run(self) -> None:
"""
Loads data, thus enabling :code:`get_similarity_matrix` and :code:`get_covariance_matrix`
Loads data, thus enabling :meth:`get_similarity_matrix` and :meth:`get_covariance_matrix`
methods in the base class.
"""
nasdaqdatalink.ApiConfig.api_key = self._token
Expand Down

0 comments on commit 0ca7b4a

Please sign in to comment.