[R-pkg-devel] Package Anchored Links with R-Dev

Ben Bolker bbo|ker @end|ng |rom gm@||@com
Sun Aug 9 21:15:08 CEST 2020

On 8/9/20 3:08 PM, Duncan Murdoch wrote:
> On 09/08/2020 2:59 p.m., John Mount wrote:
>> Firstly: thanks to Ben for the help/fix.
>> I know nobody asked, but.
>> Having to guess where the documentation is just to refer to it is 
>> just going to be really brittle going forward. Previous: if the 
>> function you referred to existed in the package you were fine.
> That's not correct.  The system could often work around the error, but 
> not always.

   I may be missing something. It may well be that referring to a 
cross-package link by alias rather than by the name of the Rd page 
actually never worked, but: would there be a big barrier to making 
cross-package documentation links be able to follow aliases? I can 
imagine there may be technical hurdles but it seems like a well-defined 
problem ...

> Duncan Murdoch
>  Future: if don't correctly specify where the help is you are wrong. 
> Going forward: reorganizing a package's help can break referring 
> packages. This sort of brittleness is going to be a big time-waster 
> going forward. It seems like really the wrong direction in packaging, 
> isolation, and separation of concerns (SOLID style principles).
>>> On Aug 9, 2020, at 11:04 AM, Ben Bolker <bbolker using gmail.com> wrote:
>>> This might have to be \link[utils:debugger]{dump.frames} now, i.e.
>>> explicitly linking to the man page on which dump.frames is found
>>> rather than following aliases?
>>> On Sun, Aug 9, 2020 at 2:01 PM John Mount <jmount using win-vector.com> 
>>> wrote:
>>>> With "R Under development (unstable) (2020-07-05 r78784)" (Windows) 
>>>> documentation references such as "\link[utils]{dump.frames}" 
>>>> trigger "Non-file package-anchored link(s) in documentation object" 
>>>> warnings even if the package is in your "Imports."
>>>> Is that not the right form? Is there any way to fix this other than 
>>>> the workaround of just removing links from the documentation? I 
>>>> kind of don't want to do that as the links were there to help the 
>>>> user.
>>>> ______________________________________________
>>>> R-package-devel using r-project.org mailing list
>>>> https://stat.ethz.ch/mailman/listinfo/r-package-devel
>> ______________________________________________
>> R-package-devel using r-project.org mailing list
>> https://stat.ethz.ch/mailman/listinfo/r-package-devel

More information about the R-package-devel mailing list