robotcode icon indicating copy to clipboard operation
robotcode copied to clipboard

[ENHANCEMENT] Add specific toml examples to the documentation

Open ngblume opened this issue 1 year ago • 1 comments

Is your enhancement request related to a problem? Please describe.

I struggle with mapping the current description of several items in the config options via toml, i.e. https://robotcode.io/03_reference/config#extend-listeners... The specification says "dict[str, list[str | StringExpression]] | None" for type, but the example is an example when not using robot.toml, but rather cli for robot itself... I just find examples missing, of how to do it propery with robot.toml, rather than saying "does the same as original cli parameter zzz"

Describe the solution you'd like

For example, with regards to https://robotcode.io/03_reference/config#extend-listeners, I would like to have examples like such: extend-listeners = {'AddLogStartEndTestcase' = ['arg1', 'arg2']} which extends the existing listeners by the listener 'AddLogStartEndTestcase', passing two arguments to the listener...

Describe alternatives you've considered

n/a

Additional context

n/a

ngblume avatar Feb 03 '25 19:02 ngblume

Quick follow-up: Maybe I don't get it, but there seems to be no "correct" way to specific "None" for an entry in a TOML file.. I tried to specify "max-error-lines" with None for a debugging profile like such: max-error-lines = None But this created an error with robotcode saying that the config file was invalid.. Quick search so far says, that None ist not a viable value for TOML... Any ideas on that?

Thanks!

ngblume avatar Aug 18 '25 06:08 ngblume