search

Dasonk / docstring

Provides docstring like functionality to R functions without requiring the need to create a package.
57 stars 6 forks source link

Override source? #22

Open talgalili opened 6 years ago

talgalili commented 6 years ago

Your package is a great thing but it requires to have the comments inside rhe functions. How about to offer a helper function to override the function 'source' so it would give us function + their parsed help files?

Dasonk commented 6 years ago

One thing I want to do is offer a helper function that would overwrite the source files with the functions free of the comments and have the comments moved before the function definition so that it's valid roxygen that you could use directly for package documentation. Maybe that's what you were implying but I took your suggestion as create the .Rd files and get rid of the comments entirely which I wouldn't want to do.

I still have to implement this helper function. It's something I plan on doing but just haven't gotten around to it yet.