I think we can extract a few good practices regarding documentation of the top level modeling function. A few that come to mind are:
Clearly document what x can be since we are going to allow it to be a data frame, matrix, or recipe.
Since the methods have very different signatures, I think it is good practice to use @rdname model_generic on methods such as model_generic.data.frame to ensure that the S3 method for data frame shows up on the documentation page. That way users can know that data frames are allowed, otherwise they are like 🤷♂️
I think we can extract a few good practices regarding documentation of the top level modeling function. A few that come to mind are:
xcan be since we are going to allow it to be a data frame, matrix, or recipe.@rdname model_genericon methods such asmodel_generic.data.frameto ensure that the S3 method for data frame shows up on the documentation page. That way users can know that data frames are allowed, otherwise they are like 🤷♂️