Issue1214

Title augment documentation of landmark heuristics and add assertions to plugin documentation code
Priority bug Status resolved
Superseder Nosy List jendrik, malte, simon
Assigned To Keywords
Optional summary

Created on 2026-04-06.12:07:43 by simon, last changed by malte.

Messages
msg12071 (view) Author: malte Date: 2026-04-17.21:04:12
Thanks for taking care of this! I assume you've verified that the documentation now looks as it should be, so I'm not checking the documentation myself.

The issue title is misleading, so I'm updating it for the purpose of the change log for the next release. Phrased like this, we would typically mean it as the *action* that was done, but you meant it exactly the other way around, and also it doesn't reflect what was actually done in the end.
msg12064 (view) Author: simon Date: 2026-04-16.12:08:52
Esther reviewed the PR and we merged it.
msg12062 (view) Author: simon Date: 2026-04-15.18:10:25
I made a small PR (~40 lines changed and most of them are moved text) for the issue that is ready for review
https://github.com/aibasel/downward/pull/289

I moved the part of the synopsis that is replaced later on to a 'note' instead.
Additionally, I added assertions to prevent such documentation bugs in the future.
msg12055 (view) Author: simon Date: 2026-04-06.12:07:43
In the cc file https://github.com/aibasel/downward/blob/main/src/search/landmarks/landmark_sum_heuristic.cc
we want to add to the documentation that landmark_sum is "Formerly known as the landmark heuristic or landmark count heuristic".

This does not appear on the website 
https://www.fast-downward.org/HEAD/documentation/search/Evaluator/#landmark_sum_heuristic

The reason is that we first set the specific synopsis but later call `add_landmark_heuristic_options_to_feature(*this, "landmark_sum_heuristic");`
which writes some general synopsis about landmark heuristics i.e. it calls `feature.document_synopsis("[...]")`.

The way 'document_synopsis' is implemented in `plugins/plugin.cc`
it replaces the synopsis.
I think the correct thing would be to add to it.
History
Date User Action Args
2026-04-17 21:04:12maltesetmessages: + msg12071
title: Replacing Synopsis instead of extending it -> augment documentation of landmark heuristics and add assertions to plugin documentation code
2026-04-16 12:08:52simonsetmessages: + msg12064
status: chatting -> resolved
2026-04-15 18:10:25simonsetmessages: + msg12062
status: unread -> chatting
2026-04-06 12:07:54simonsetnosy: + malte, jendrik
2026-04-06 12:07:43simoncreate