qt: Expose markup conversion utils #706
Conversation
Expose `as_markup_covert()` function and `AsMarkUpKind` enum, so Qt clients can use the description fields in other suitable formats, such as markdown or simple text
|
This looks good, but is there any better way to send the error back to the caller, rather than to dump it on the console as a sideeffect? |
I've been trying to find some good way to do it, while keeping the API still convenient, leaning into an optional parameter, maybe a But trying to understand which kind of errors can be produced, it seems the Line 216 in cac6772 |
|
The error parameter exists so we can add an error in future in case there are parsing errors that we want to handle, and can add them without breaking API. Clients now would likely simply show the The most straightforward way to convey this would be to emit a C++ exception, but introducing an exception into a library that otherwise doesn't use them would be a bad idea and quite surprising for users of the library. |
|
That you for the patch! I will have a look if it's possible to use |
Thanks for merging! I struggled to find a good way to expose the error handling (idiomatic and convenient) but |
|
Yes, while I think |
Expose
as_markup_covert()function andAsMarkUpKindenum, so Qt clients can use the description fields in other suitable formats, such as markdown or simple text