Whenever you refer to a function, put parentheses after the function name, for example GenericML(). Whenever your refer to a class, put the class in double quotation marks, for example "GenericML".
This makes it much easier to follow what we're referring to. For example, we currently often use something like this:
"Must be an instance of setup_X1. See the documentation of setup_X1 for details."
It's much easier to understand if we write (also note that I added the words class and function to make it even more clear):
"Must be an instance of class "setup_X1". See the documentation of function setup_X1() for details."
You should add the parentheses or quotation marks inside the \code{} statements, but obviously outside of the \link{} statements.
Whenever you refer to a function, put parentheses after the function name, for example
GenericML()
. Whenever your refer to a class, put the class in double quotation marks, for example"GenericML"
.This makes it much easier to follow what we're referring to. For example, we currently often use something like this:
"Must be an instance of
setup_X1
. See the documentation ofsetup_X1
for details."It's much easier to understand if we write (also note that I added the words class and function to make it even more clear):
"Must be an instance of class
"setup_X1"
. See the documentation of functionsetup_X1()
for details."You should add the parentheses or quotation marks inside the
\code{}
statements, but obviously outside of the\link{}
statements.