Issue1144

Title Change representation of string parameters in documentation.
Priority wish Status resolved
Superseder Nosy List clemens, florian, jendrik, malte
Assigned To Keywords
Optional summary
Pull request: https://github.com/aibasel/downward/pull/229

Created on 2024-07-10.12:13:17 by clemens, last changed by florian.

Summary
Pull request: https://github.com/aibasel/downward/pull/229
Messages
msg11680 (view) Author: florian Date: 2024-07-26.10:25:23
Done, thank you.
msg11678 (view) Author: malte Date: 2024-07-26.09:54:45
Looks good to me, feel free to merge.
msg11677 (view) Author: florian Date: 2024-07-25.21:16:24
Now that the sprint is over this looks like very low-hanging fruit. Any objections to merging this?
msg11626 (view) Author: malte Date: 2024-07-10.13:16:43
Having this in the plugin code perhaps makes more sense. "utils/language" is meant to be reusable for all kinds of projects, and the precise choice of user-visible name for this type might be considered somewhat specific to the plugin module.
msg11624 (view) Author: florian Date: 2024-07-10.12:29:55
We already had a first look but don't want to spend too much time on this during the sprint. 

One option would be to add an optional parameter here:
https://github.com/aibasel/downward/blob/main/src/search/plugins/types.cc#L295
which is then used instead of utils::get_type_name<T>() here:
https://github.com/aibasel/downward/blob/main/src/search/plugins/types.cc#L303

An alternative would be to use template specialization for utils::get_type_name<std::string>() here:
https://github.com/aibasel/downward/blob/main/src/search/utils/language.h#L19
msg11622 (view) Author: clemens Date: 2024-07-10.12:13:17
When automatically generating the documentation for the Wiki, the type information for `string` types is translated to `std::cxx11::basic_string<char>`. This should be manually overwritten to something more readable like `string`.
History
Date User Action Args
2024-07-26 10:25:23floriansetstatus: chatting -> resolved
messages: + msg11680
2024-07-26 09:54:45maltesetmessages: + msg11678
2024-07-25 21:16:24floriansetmessages: + msg11677
summary: Pull request: https://github.com/aibasel/downward/pull/229
2024-07-10 13:16:43maltesetmessages: + msg11626
2024-07-10 12:29:55floriansetmessages: + msg11624
2024-07-10 12:13:17clemenscreate