Add #341 to docs, whatsnew

Author: khaeru

doc/api/tools.rst

@@ -58,6 +58,7 @@ Exogenous data (:mod:`.tools.exo_data`)
 
 .. autoclass:: ExoDataSource
    :members:
+   :private-members: _where
    :special-members: __init__, __call__
 
 .. currentmodule:: message_ix_models.tools.advance

doc/index.rst

@@ -53,9 +53,10 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
 - :doc:`api/report/index`
 - :doc:`api/tools`
 - :doc:`api/data-sources`
+- :doc:`api/workflow`
 - :doc:`api/util`
 - :doc:`api/testing`
-- :doc:`api/workflow`
+- :doc:`api/tests`
 
 .. toctree::
    :maxdepth: 2
@@ -73,9 +74,11 @@ Commonly used classes may be imported directly from :mod:`message_ix_models`.
    api/tools-costs
    api/tools-messagev
    api/data-sources
+   api/workflow
    api/util
    api/testing
-   api/workflow
+   api/tests
+
 
 .. toctree::
    :maxdepth: 2

doc/whatsnew.rst

@@ -16,6 +16,8 @@ Next release
   - :py:`transform="C"` / :func:`.transform_C` (:issue:`229`, :pull:`300`).
   - The :class:`~.web.TRANSFORM` enumeration for specifying and validating multiple transformations.
 
+- Improve :class:`.ExoDataSource` with :attr:`~.ExoDataSource.use_test_data`,
+  :attr:`~.ExoDataSource.where`, and :meth:`~.ExoDataSource._where` (:pull:`341`).
 - New class :class:`.Dataflow` for describing input and/or output data flows (:pull:`300`) that are read from file and attached to a :class:`.Computer`.
   Generalized from former :py:`.transport.files.ExogenousDataFile`.
 - New method :meth:`.Config.regions_from_scenario` (:pull:`300`),
@@ -29,8 +31,19 @@ Next release
   - :func:`.check.verbose_check` (:pull:`300`).
 
 - Display entire result quantity in :func:`.report.report` / :program:`mix-models report` with :py:`verbose=True` (:pull:`300`).
+- New test fixtures (:pull:`341`):
+  :func:`.advance_test_data`,
+  :func:`.gea_test_data`,
+  :func:`.gfei_test_data`,
+  :func:`.iea_eei_user_data`,
+  :func:`.iea_eweb_test_data`,
+  :func:`.iea_eweb_user_data`,
+  :func:`.shape_test_data`,
+  :func:`.ssp_test_data`,
+  :func:`.ssp_user_data`.
 - Bug fix: :program:`mix-models --verbose` command-line option was not stored on :class:`.Context`/:class:`~.util.Config` (:pull:`300`).
-- Bug fix: adjust or guard some Python usage that was not compatible with Python 3.9—the earliest version supported by :mod:`message_ix_models` (:pull:`295`, :issue:`294`).
+- Bug fix: adjust or guard some Python usage that was not compatible with Python 3.9
+  —the earliest version supported by :mod:`message_ix_models` (:pull:`295`, :issue:`294`).
 - Drop obsolete :py:`series_of_pint_quantity()` (:pull:`289`).
 
 By topic:
@@ -108,6 +121,8 @@ Documentation
 - Expand the :ref:`costs-usage` section of the :mod:`.tools.costs` documentation to describe the requirement for SSP input data (:issue:`313`, :pull:`322`).
 - Reorganize and improve the :doc:`data` documentation page (:pull:`326`).
 
+.. _v2025.1.10:
+
 v2025.1.10
 ==========
 

message_ix_models/tools/exo_data.py

@@ -110,7 +110,11 @@ def __call__(self) -> Quantity:
 
     @classmethod
     def _where(self) -> list[Union[str, "Path"]]:
-        """Helper for :py:`__init__()` methods in subclasses."""
+        """Helper for :py:`__init__()` methods in subclasses.
+
+        Return :attr:`where`, but if :attr:`use_test_data` is :any:`True`, also append
+        :py:`["test"]`.
+        """
         return self.where + (["test"] if self.use_test_data else [])
 
     def get_keys(self) -> tuple[Key, Key]: