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

Fix/build manual #231

Merged
merged 6 commits into from
Dec 12, 2024
Merged

Fix/build manual #231

merged 6 commits into from
Dec 12, 2024

Conversation

dcollins15
Copy link
Collaborator

This PR applies some housekeeping changes to the package's DESCRIPTION file. Critically, the "BuildManual" field is added and set to true.

As far as I have been able to suss out, as of R v4.3.2, R CMD build requires the BuildManual field to be true in order for the package's PDF manual to be generated, even if there are install-time or render-time /Sexpr macros are present in the package's man/*.Rd files. Currently, the following NOTE is being thrown by CRAN checks (the last line is the problematic one):

❯ checking CRAN incoming feasibility ... [6s/19s] NOTE
  Maintainer: ‘Rahul Satija <seurat@nygenome.org>’
  
  Version contains large components (5.0.99.9003)
  
  Suggests or Enhances not in mainstream repositories:
    BPCells
  Availability using Additional_repositories specification:
    BPCells   yes   https://bnprks.r-universe.dev/
  
  Package has help file(s) containing install/render-stage \Sexpr{} expressions but no prebuilt PDF manual.

I first encountered this issue while cutting the release for SeuratObject v5.0.2 but attributed it to a problem with my local environment. Upon digging deeper, I noticed that the successful build used R v4.2.2 and was eventually able to pinpoint the issue to this change in the R source code, which updated the default value for the "BuildManual" field from TRUE to FALSE 🕵️

Curiously, CRAN's documentation on writing R extensions appears to describe the old behavior 🤷

The only other non-cosmetic change introduced in this PR is that the "Type" field was dropped from the package's DESCRIPTION—this field defaults to "Package" and can only take one other value ("Frontend"). The main motivation for dropping it is for consistency with Seurat 🤓

@dcollins15
Copy link
Collaborator Author

I had been fiddling around with the repository settings and accidentally disabled third-party actions—I've adjusted the relevant setting now. Closing and re-opening to trigger CI checks.

@dcollins15 dcollins15 closed this Dec 12, 2024
@dcollins15 dcollins15 reopened this Dec 12, 2024
@dcollins15 dcollins15 merged commit 85ce300 into main Dec 12, 2024
1 check passed
@dcollins15 dcollins15 deleted the fix/build_manual branch December 12, 2024 22:19
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

Successfully merging this pull request may close these issues.

2 participants