search

TommyJones / tidylda

Implements an algorithim for Latent Dirichlet Allocation using style conventions from the [tidyverse](https://style.tidyverse.org/) and [tidymodels](https://tidymodels.github.io/model-implementation-principles/index.html).
Other
41 stars 3 forks source link

move documentation of tidylda object from new_tidylda() to tidylda() #61

Closed TommyJones closed 3 weeks ago

TommyJones commented 2 years ago

new_tidylda() is not exported, so you should document the class in the exported function that a user actually calls

TommyJones commented 2 years ago

I'm not sure this is worth doing anymore. tidylda's documentation does link to new_tidylda. So even though new_tidylda isn't exported, its documentation does exist, is viewable by users in the application version of documentation (though not the PDF reference manual), and puts the object documentation with the function that technically creates it. Keeping this open while I think it over, but for now the issue is trending towards "won't fix"

TommyJones commented 3 weeks ago

Per my above comment, I'm not doing this unless I get complaints or it otherwise becomes obvious that it's needed.