search

Wetator / wetator

Other
2 stars 0 forks source link

Improve test case documentation possiblities #10

Open rbri opened 3 years ago

rbri commented 3 years ago

% migrated from trac

At the moment I can only comment my test cases using the comment command. This is a line by line documentation possibility that helps me structuring my test case - and that's it.

I'd like to have the possibility to document in the test case itself - what it is for, what it is testing - like I may do in javadoc for JUnit tests with HTML.

For achieving this I propose enhancing the existing comment command by accepting WIKI language for a flexible commenting and documentation solution. Then I could document my test cases in various comments and also include this in a well formatted way in the Wetator result report.

rbri commented 3 years ago

+1

But we have to think about how the WTE can support this. Adjustable line height (per line)? Preview for the generated Richtext/HTML? Help page for the Wiki markup?

Only having one line to enter the raw Wiki markup does not help the user so much, does it?

rbri commented 3 years ago

with version 1.1 we have the describe command, maybe we have to tweak this in the future