Michal/common_test/add-information-about-ct:comment-to-documentation #10271
Conversation
Mikaka27
added
team:PS
CT Test Results 2 files 57 suites 1h 16m 41s ⏱️ Results for commit 057db1f. ♻️ This comment has been updated with latest results. To speed up review, make sure that you have read Contributing to Erlang/OTP and that all checks pass. See the TESTING and DEVELOPMENT HowTo guides for details about how to run test locally. Artifacts// Erlang/OTP Github Action Bot |
|
|
||
| [](){: #comment } | ||
|
|
||
| ### Comment in hooks |
There was a problem hiding this comment.
what about this different process organization depending on how you install a hook?
There was a problem hiding this comment.
Added table that presents this information
Mikaka27
force-pushed
the
michal/common_test/add-information-about-group-leader-for-ct-comment
branch
from
d11ba21 to
057db1f
Compare
|
|
||
| This table presents information where `ct:comment/1-2` prints to, depending on how hook was installed: | ||
|
|
||
| | Hook function | Install in: `ct_run`, `ct:run_test/1`, Test Specification | Install in: suite/0, init_per_suite/1, init_per_group/2 | |
There was a problem hiding this comment.
good to know how it behaves.
let's discuss on some occasion, if this should be documented and should it be done that way or other.
@IngelaAndin
There was a problem hiding this comment.
I think this text looks good as external doc but I do not think we should repeat it in two places. Decide on one an link it from the other place.
| | terminate/1 | nowhere | end_per_suite row | | ||
|
|
||
| _Table: Behavior of `ct:comment/1-2` depending on hook installation method_ | ||
|
|
There was a problem hiding this comment.
I think this is to detailed for external documentation, and could potential get forgotten when updating, I have not check, are all these functions documented callbacks? Perhaps this should be interna doc only. Maybe it would be possible
to write something like "all per_testcase functions will write comment to ..." etc
There was a problem hiding this comment.
yes. I would prefer table to go to into internal docs as might be useful for us in future.
in external docs I would like a info note that for some callbacks ct:comment operation might not work (can it be easily explained why?). maybe list exact the callbacks.
then maybe have 2nd info note explaining that method of hook installation might further impact the above list (again, can it be easily explained why?). mayble list exact callbacks.
Providing some brief explanation, might be educative to users wanting to understand how stuff works.
3 participants
No description provided.