Re: [Rd] Fwd: Re: Best practices in developing package:

2018-02-01 Thread Michael Lawrence
Folding is a simple solution, but there are intrinsic problems, like the need to embed the documentation in comments. If the user already has to expand a fold to edit the docs, the IDE could instead just provide a link or shortcut that jumps to a separate documentation file, written in whatever lan

Re: [Rd] Fwd: Re: Best practices in developing package:

2018-02-01 Thread Lionel Henry
> On 1 févr. 2018, at 06:51, Therneau, Terry M., Ph.D. > wrote: > > A second is that I care a lot about documentation so my help files are > fairly long, so much so that the advantage of having the documentation of an > argument > "close" to the declaration of said argument is lost. Good poin

[Rd] Fwd: Re: Best practices in developing package:

2018-02-01 Thread Therneau, Terry M., Ph.D.
I'm not going to force anyone to use roxygen2. But I personally find it easier to have the function right below the documentation, so that any change to the function can immediately be documented as well. You prefer to do this by keeping that strictly separated, which is absolutely fine. It's just