altdoc icon indicating copy to clipboard operation
altdoc copied to clipboard

Error in CRAN checks

Open etiennebacher opened this issue 1 year ago • 8 comments

To fix before January 28: https://cran.r-project.org/web/checks/check_results_altdoc.html

I think this was fixed in https://github.com/etiennebacher/altdoc/commit/c50ebef035e81aeb225f68fa27d7e9c86387268a

@vincentarelbundock let me know if you want to do some modifications before I release 0.5.0. Not in rush anyway.

etiennebacher avatar Jan 07 '25 10:01 etiennebacher

Exposing import_man and import_vignettes to users would be nice, but I'm not sure I'll have time to work on that in the near future.

https://github.com/etiennebacher/altdoc/issues/298#issuecomment-2571669950

vincentarelbundock avatar Jan 07 '25 10:01 vincentarelbundock

I might work on this but nothing guaranteed. I'd like to submit on Jan 21 at the latest, just in case there are still errors in CRAN checks, so that leaves some time.

etiennebacher avatar Jan 07 '25 10:01 etiennebacher

I'll make a new release today

etiennebacher avatar Jan 23 '25 13:01 etiennebacher

This is still an issue which can be reproduced running altdoc::render_docs() from the terminal. Also, for some reason a window pops up when throwing the error.

Here a screenshot

Image

For some reason which i don't understand it works in the RStudio IDE.

vedoa avatar May 12 '25 13:05 vedoa

I can't reproduce the error in the terminal so I would need a bit more info on what your man page actually contains, the documentation tool used, and the altdoc version.

I can reproduce the window opening but I don't know where it comes from since I haven't even called preview_docs() yet.

etiennebacher avatar May 18 '25 06:05 etiennebacher

I made a reproducible example https://github.com/vedoa/altdoc-issue304. Here the runs to reproduce the issue on all 3 mayor platforms https://github.com/vedoa/altdoc-issue304/actions/runs/15094771429

vedoa avatar May 18 '25 10:05 vedoa

Thanks but I still can't reproduce. I see you're installing the CRAN version of altdoc, can you try with the devel version?

etiennebacher avatar May 18 '25 10:05 etiennebacher

I still get the same - even with the devel version. For reference https://github.com/vedoa/altdoc-issue304/actions/runs/15095670336. I also see the same error message in https://cran.r-project.org/web/checks/check_results_altdoc.html for today mainly on mac builds. The same setup that i have just works either in RStudio (windows) or running in a docker container like rocker/verse:4.4.3. You also seem not to have any problems. So, I will leave the repository altdoc-issue304 for now - maybe i realize my mistake once it pops up somewhere else. Thanks for the effort looking into it.

vedoa avatar May 18 '25 12:05 vedoa

Sorry for the late reply, I found the issue in the end. The problem is that you installed the R package quarto but not the command line tool quarto (the one that can be installed from https://quarto.org/docs/get-started/).

Quarto is needed for rendering the man pages. After #329, a proper error message will be shown.

etiennebacher avatar Jun 22 '25 12:06 etiennebacher

Thanks a lot for the feedback. For reference https://github.com/vedoa/altdoc-issue304/actions/runs/15806898705 works as you described - once the quarto cli is installed the build works (even with the CRAN version of altdocs). I will archive the repo with the example github action for future reference.

This is also why it was always working out in Rstudio - it has quarto integrated in the IDE.

vedoa avatar Jun 22 '25 13:06 vedoa