+1 for the changes suggested by Dilini Also I like the suggestion by Sajith. I guess the factors to consider would be Simplicity vs being descriptive enough so that the user understands what to pass to the function.
Rather than introducing a separate field for parameter descriptions, can't we manage by explaining the parameters within the extension description if needed. Since we are having examples as well, user will get an additional hint as to what to pass in parameters. In simple cases, I think the parameters will be self explanatory (given that the API is designed in an easy to understand way... :-)). So am inclined not to keep a field for param descriptions if not absolutely necessary. Also, a small suggestion regarding the presenting of the documentation.. Can we make the variable types bold or in a different colour or use some other means of emphasis to make the type stand out? e.g. abs(a *<double,int,float,long>*) Thanks, Lasantha On 29 April 2015 at 22:24, Sajith Ravindra <[email protected]> wrote: > Shouldn't we describe the parameters. For an example what are the possible > values the range, what are invalid parameters(may be with an explination). > I think it will be usefull for complex extesions. > On 29 Apr 2015 23:59, "Dilini Muthumala" <[email protected]> wrote: > >> Hi, >> I like the format. Would like to suggest an improvement, marked in blue: >> Math >> >> abs(a double/int/float/long) >> >> - Extension Type: Function >> - Description: Returns the absolute value of 'a'. >> - Return Type(s): double >> - Example: abs(3) returns 3, and abs(−3) also returns 3. >> >> >> Example field could be optional. >> >> Thanks, >> Dilini >> >> On Wed, Apr 29, 2015 at 9:18 AM, Sriskandarajah Suhothayan <[email protected] >> > wrote: >> >>> Hi all >>> >>> Recently we have implemented several Siddhi extensions and we thought of >>> documenting them as here[1] >>> >>> Please provide you feedback on the format. >>> >>> If we need to change the format we have to change it fast else after >>> adding all the functions it will be very hard to change the format. >>> >>> Regards >>> Suho >>> >>> [1]https://docs.wso2.com/display/CEP400/Siddhi+Extentisions >>> -- >>> >>> *S. Suhothayan* >>> Technical Lead & Team Lead of WSO2 Complex Event Processor >>> *WSO2 Inc. *http://wso2.com >>> * <http://wso2.com/>* >>> lean . enterprise . middleware >>> >>> >>> *cell: (+94) 779 756 757 <%28%2B94%29%20779%20756%20757> | blog: >>> http://suhothayan.blogspot.com/ <http://suhothayan.blogspot.com/>twitter: >>> http://twitter.com/suhothayan <http://twitter.com/suhothayan> | linked-in: >>> http://lk.linkedin.com/in/suhothayan <http://lk.linkedin.com/in/suhothayan>* >>> >> >> >> >> -- >> *Dilini Muthumala* >> Software Engineer, >> WSO2 Inc. >> >> *E-mail :* [email protected] >> *Mobile: *+94 713-400-029 >> > -- *Lasantha Fernando* Software Engineer - Data Technologies Team WSO2 Inc. http://wso2.com email: [email protected] mobile: (+94) 71 5247551
_______________________________________________ Dev mailing list [email protected] http://wso2.org/cgi-bin/mailman/listinfo/dev
