-
Notifications
You must be signed in to change notification settings - Fork 98
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
Core: Allow @ExtendedDescription annotation on test methods #35
Comments
Hi, While waiting for this useful feature, is there an equivalent that would allow us to explain the rational behind our scenarios ? Moreover, do you plan to display the extended description accordingly to the steps ones or in another way (close to a tag's description for example) ? |
Currently the only way is to use JavaDoc comments. But these will not appear in the report. It is not clear to me yet what the best way of showing this information would be. I think I have to experiment a bit. Having a tooltip like for the steps would be one possible option. If you have a good suggestion, let me know :-) |
I was thinking about the tooltip too. Another option, as suggested in my previous comment, would be to display it as a caption of the scenario. We could provide the two alternatives using an annotation attribute. |
So the caption would be in a smaller font directly above the scenario and already visible when scenario is not expanded? |
Exactly. One will have to experiment a bit to find the best style (smaller size, italic font, etc.). |
I have tried three different ways: having a small description above the title, having a tooltip on the title and having a separate icon behind the title with a tooltip. I liked the third solution most. Please tell me what you think. Here is the report of the current implementation: http://jgiven.org/snapshot/jgiven-report/html5/#/tag/HTML5%20Report |
Hi Jan. Thanks for the tests. Moreover, I would try with a formatted content as the explanation could be greater than a single sentence. Did you plan anything about this? Great job anyway. |
Regarding the Icon: Choose one: http://fortawesome.github.io/Font-Awesome/icons/ :-) Regarding the formatting, you are right. A tool tip is a bit limited in this sense. I will think about that a bit more. |
This one could be great: http://fortawesome.github.io/Font-Awesome/icon/question-circle/ Thanks a lot for the job. ;) |
Ok. I have now changed the icon and addition also show the extended description as a subheader below the title (so you can better compare both approaches): http://jgiven.org/snapshot/jgiven-report/html5/#/tag/HTML5%20Report The sub header is now always visible. |
Hi Jan, The subheader/caption approach seems to be the best one. I would add an attribute to the annotation to determinate the default visibility, keeping the icon to toggle the caption. I would also reduce the caption's font size (from 1.1 em to 0.8 em). What do you think about this solution? |
Ok, I have experimented a lot now. It is harder than I initially thought :-) Please have another look: http://jgiven.org/snapshot/jgiven-report/html5/#/tag/HTML5%20Report |
Hi Jan, I agree with you about the toggle feature. |
Great. Then I close this issue for now. If we have further ideas we can create a new issue. |
With an
@ExtendedDescription
tag on test methods it would be possible to explain in more detail the rational behind a scenario.The text was updated successfully, but these errors were encountered: