Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Non-file package-anchored link(s) in documentation object #118

Closed
achubaty opened this issue Jun 16, 2020 · 3 comments
Closed

Non-file package-anchored link(s) in documentation object #118

achubaty opened this issue Jun 16, 2020 · 3 comments

Comments

@achubaty
Copy link
Contributor

achubaty commented Jun 16, 2020

New check in R-devel is revealing some problems with help cross-links.

See discussion here: https://stat.ethz.ch/pipermail/r-package-devel/2020q2/005562.html

* checking Rd cross-references ... WARNING
Non-file package-anchored link(s) in documentation object 'Plot.Rd':
  '[quickPlot]{gpar}'
Non-file package-anchored link(s) in documentation object 'SpaDES.core-package.Rd':
  '[SpaDES.tools]{directionFromEachPoint}' '[SpaDES.tools]{move}'
  '[SpaDES.tools]{specificNumPerPatch}'
  '[SpaDES.tools]{rasterizeReduced}'
  '[quickPlot:setColors<-]{setColors}' '[SpaDES.tools]{gaussMap}'
  '[SpaDES.tools]{agentLocation}' '[SpaDES.tools]{numAgents}'
  '[SpaDES.tools]{probInit}' '[SpaDES.tools]{transitions}'
  '[reproducible]{Cache}' '[reproducible]{showCache}'
  '[reproducible]{clearCache}' '[reproducible]{keepCache}'
Non-file package-anchored link(s) in documentation object 'addChangedAttr.Rd':
  '[reproducible]{.addChangedAttr}'
Non-file package-anchored link(s) in documentation object 'addTagsToOutput.Rd':
  '[reproducible]{.addTagsToOutput}'
Non-file package-anchored link(s) in documentation object 'cacheMessage.Rd':
  '[reproducible]{.cacheMessage}'
Non-file package-anchored link(s) in documentation object 'checkCacheRepo.Rd':
  '[reproducible]{.checkCacheRepo}'
Non-file package-anchored link(s) in documentation object 'parseElems.Rd':
  '[quickPlot]{.parseElems}'
Non-file package-anchored link(s) in documentation object 'preDigestByClass.Rd':
  '[reproducible]{.preDigestByClass}'
Non-file package-anchored link(s) in documentation object 'prepareOutput.Rd':
  '[reproducible]{.prepareOutput}'
Non-file package-anchored link(s) in documentation object 'setPaths.Rd':
  '[raster]{tmpDir}'
Non-file package-anchored link(s) in documentation object 'spades.Rd':
  '[reproducible]{Cache}'
Non-file package-anchored link(s) in documentation object 'tagsByClass.Rd':
  '[reproducible]{.tagsByClass}'
See section 'Cross-references' in the 'Writing R Extensions' manual.
achubaty added a commit that referenced this issue Jun 17, 2020
achubaty added a commit that referenced this issue Jun 17, 2020
@achubaty
Copy link
Contributor Author

The last one is annoying, because I think it's coming in via @inheritParams quickPlot::Plot or something, but I haven't been able to track it down.

* checking Rd cross-references ... WARNING
Non-file package-anchored link(s) in documentation object 'Plot.Rd':
  ‘[quickPlot]{gpar}’
See section 'Cross-references' in the 'Writing R Extensions' manual.

@achubaty
Copy link
Contributor Author

achubaty commented Jun 17, 2020

possibly solved in PredictiveEcology/quickPlot@a070ae8

update: nope, not solved yet

@achubaty
Copy link
Contributor Author

this 'feature' was enabled, then recently disabled again in R-devel. A fix is forthcoming. closing issue here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant