Hi Krishna, First of all, thanks for doing this! This feature is very exciting and I'm glad to have you working on it :)
I have some comments about the documentation: - "Any function of the form ... is treated as a test function". - I would go into a little more detail about what causes this function to be treated specially from other functions. The declaration is relatively simple, but it would still be good to guide the reader in what to look at and care about, otherwise they are just going to take stabs in the dark around what you have specified. - In your examples, it might be handy to provide links to the methods that are being used. For instance, the first example could read: "Example (using :proc:`Test.assertTrue`, :proc:`runTest`)" - The :proc:`blah` syntax causes the documentation to insert a link to the function being referred to. This syntax is described in more detail in the chpldoc documentation here: https://chapel-lang.org/docs/latest/tools/chpldoc/chpldoc.html#id7 - Doing this would allow users to jump immediately to what is being used in the example if they want to learn more about that particular function. - You've got a few typos in here that it would be good to address before the final merge. For instance, "rasies" is there a few times, and "seperated". - We also try to surround things like "==" with ``, which would look like this: ``==``. This makes those symbols pop more in the documentation. Otherwise, I like this documentation :) Thanks, Lydia On 7/13/19 4:13 AM, Krishna Kumar Dey wrote: Hey All, We have added more feature in UnitTest Framework. Among which are : 1. Giving the user a feature of specifying the no of locales with which test can be run. For this 3 method: maxLocales(), minLocales(), addNumLocales() have been given. 2. User can now also specify the tests in which it depends on using dependsOn() method. You can find the whole documentation here https://krishnadey30.github.io/UnitTest-Docs<https://krishnadey30.github.io/UnitTest-Docs/modules/test/library/packages/UnitTest/UnitTest.html>. It would be very helpful if I can get some feedback on this. On Mon, Jun 17, 2019 at 7:17 PM Krishna Kumar Dey <[email protected]<mailto:[email protected]>> wrote: Hey All, Please find the updated link to the documentation below. https://krishnadey30.github.io/UnitTest-Docs/ On Mon, Jun 17, 2019 at 6:12 PM Krishna Kumar Dey <[email protected]<mailto:[email protected]>> wrote: Hey All, Greetings of the day. As part of my GSoC project, I have implemented the assertion Interface of Unit Test Framework. Please find the link to the documentation of current Interface. https://unittest-chapel.000webhostapp.com/ You can find the source code here<https://github.com/chapel-lang/chapel/blob/master/test/library/packages/UnitTest/UnitTest.chpl> Also, find the link to the proposed design of the Unit Test Framework https://github.com/chapel-lang/chapel/issues/13098. It would be very helpful if I can get some feedback on this. -- Thank You Krishna Kumar Dey _______________________________________________ Chapel-developers mailing list [email protected]<mailto:[email protected]> https://lists.sourceforge.net/lists/listinfo/chapel-developers
_______________________________________________ Chapel-developers mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/chapel-developers
