Closed Sar-thak-3 closed 1 year ago
Hey @Sar-thak-3 , your PR is almost ready to be merged, the comments you need to add above the functions should be doc comments https://github.com/PEC-CSS/slowmokit/blob/08e2d497cbf1dcf8516570cbead34c5cd2002e3a/src/slowmokit/ducks/io/io.hpp#L15-L20 Here is an example of how the comment should look like
@Sar-thak-3 Add two stars in the beginning With a single star it is a simple multiline comment
/*
*/
With two stars it is marked as a doc comment
/**
*/
You need to write params by first writing @param
then name of variable then it's description, don't write write colons after@param
example
/**
* @param x it is a variable
*/
Also separate params should be written in separate lines, like this
/**
* @param x it is a variable
* @param y it is another variable
*/
Rest all is fine, just make these changes
Change
predict_prob
to camel case as well