Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve test case documentation possiblities #10

Open
rbri opened this issue Oct 25, 2021 · 2 comments
Open

Improve test case documentation possiblities #10

rbri opened this issue Oct 25, 2021 · 2 comments

Comments

@rbri
Copy link
Member

rbri commented Oct 25, 2021

% 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
Copy link
Member Author

rbri commented Oct 25, 2021

+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
Copy link
Member Author

rbri commented Oct 25, 2021

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant