Skip to content

Commit

Permalink
Fix docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
jendrikseipp committed Aug 9, 2023
1 parent 4318403 commit 2ae1931
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs/downward.experiment.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
.. note::

The :class:`FastDownwardExperiment
<downward.experiment.FastDownwardExperiment>` class makes it simply to write
<downward.experiment.FastDownwardExperiment>` class makes it easy to write
"standard" experiments, but it assumes a rigid experiment structure: it only
allows you to run each added algorithm on each added task, and individual
runs cannot easily be customized. If you need more flexibility, you can use
Expand Down
7 changes: 3 additions & 4 deletions docs/news.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,15 @@ v7.4 (unreleased)

Lab
^^^
* Document :class:`CachedRevision <lab.cached_revision.CachedRevision>` class (Jendrik Seipp).
* Require *revision_cache* parameter in :class:`CachedRevision <lab.cached_revision.CachedRevision>` constructor (Jendrik Seipp).
* Add *subdir* option for :class:`CachedRevision <lab.cached_revision.CachedRevision>` to support solvers residing in monolithic repos (Jendrik Seipp).
* Add :meth:`CachedRevision.get_relative_exp_path() <lab.cached_revision.CachedRevision.get_relative_exp_path>` method (Jendrik Seipp).
* Add :meth:`CachedRevision.get_relative_exp_path() <lab.cached_revision.CachedRevision.get_relative_exp_path>` method to query where cache artefacts will land (Jendrik Seipp).
* Document :class:`CachedRevision <lab.cached_revision.CachedRevision>` class (Jendrik Seipp).

Downward Lab
^^^^^^^^^^^^
* Add *subdir* option for :class:`CachedFastDownwardRevision <downward.cached_revision.CachedFastDownwardRevision>` to support nested Fast Downward repos (Jendrik Seipp).
* Make ``_DownwardAlgorithm`` available as :class:`FastDownwardAlgorithm <downward.experiment.FastDownwardAlgorithm>` (Jendrik Seipp).
* Add :class:`FastDownwardAlgorithm <downward.experiment.FastDownwardAlgorithm>`, :class:`FastDownwardAlgorithm <downward.experiment.FastDownwardRun>`and :class:`CachedFastDownwardRevision <downward.cached_revision.CachedFastDownwardRevision>` to docs (Jendrik Seipp).
* Document :class:`FastDownwardAlgorithm <downward.experiment.FastDownwardAlgorithm>`, :class:`FastDownwardRun <downward.experiment.FastDownwardRun>`and :class:`CachedFastDownwardRevision <downward.cached_revision.CachedFastDownwardRevision>` classes (Jendrik Seipp).


v7.3 (2023-03-03)
Expand Down

0 comments on commit 2ae1931

Please sign in to comment.