mwelz / GenericML

R implementation of Generic Machine Learning Inference (Chernozhukov, Demirer, Duflo and Fernández-Val, 2020).
GNU General Public License v3.0
60 stars 14 forks source link

Improve documentation #22

Closed aalfons closed 2 years ago

aalfons commented 2 years ago

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.

aalfons commented 2 years ago

Similarly, in the description of arguments, we currently often use for example:

An object of the class GenericML.

Better:

An object of the class "GenericML", as returned by function GenericML().