improve CLI documentation

This commit is contained in:
Maximilian Keßler 2024-06-14 11:20:13 +02:00
parent e602f2a41a
commit 1a2824453f
Signed by: max
GPG key ID: BCC5A619923C0BA5

View file

@ -240,7 +240,7 @@ namespace Hanabi
("file,f", bpo::value<std::string>(), "Input file containing game in hanab.live json format.") ("file,f", bpo::value<std::string>(), "Input file containing game in hanab.live json format.")
("turn,t", bpo::value<unsigned>(&parms.game_state_spec), "Turn number of state to analyze. " ("turn,t", bpo::value<unsigned>(&parms.game_state_spec), "Turn number of state to analyze. "
"Turn 1 means no actions have been taken. ") "Turn 1 means no actions have been taken. ")
("draw-pile-size,d", bpo::value<unsigned>(&parms.game_state_spec), "Draw pile size of state to analyze.") ("draw-pile-size,d", bpo::value<unsigned>(&parms.game_state_spec), "Draw pile size of state to analyze. Must be at most 20.")
("score-goal,s" ("score-goal,s"
, bpo::value<boost::optional<unsigned int>>(&parms.score_goal) , bpo::value<boost::optional<unsigned int>>(&parms.score_goal)
, "Score that counts as a win, i.e. is optimized for achieving. If unspecified, the maximum possible " , "Score that counts as a win, i.e. is optimized for achieving. If unspecified, the maximum possible "
@ -286,7 +286,6 @@ namespace Hanabi
std::cout << "You have to either specify --game or --file as a data source.\n"; std::cout << "You have to either specify --game or --file as a data source.\n";
std::cout << "You may not specify both --turn and --draw at the same time.\n"; std::cout << "You may not specify both --turn and --draw at the same time.\n";
std::cout << "You may not specifiy both --recursive and --list-actions at the same time.\n"; std::cout << "You may not specifiy both --recursive and --list-actions at the same time.\n";
std::cout << "If none of them is specified, it is assumed that --draw 5 was given." << std::endl;
return std::nullopt; return std::nullopt;
} }