Comment #2 on issue 924 by [email protected]: libdoc.py doesn't support
embedded keywords properly
http://code.google.com/p/robotframework/issues/detail?id=924
The problem is that when we have large (>4) arguments with complicated
regular expressions it becomes difficult to read the documentation. I think
the above mechanism (breaking up into 2 parts) will help simplify the
problem.
The keyword will just have a natural language description and no regex,
which will make it easier to read.
The arguments will contain the details about the regex, so that people can
figure out if they are giving wrong input.
If the embedded args do not have a custom regex, we can either just mention
Arguments
x, y
or
Arguments
x(regex=.*)
y(regex=.*)
Exact syntax and representation is not a concern. The underlying concern is
to improve the readability of the documentation. If you have any alternate
suggestions I will be happy to discuss.
