Skip to content

docs(vignette): fix placeholder VignetteIndexEntry#124

Closed
ehrlinger wants to merge 1 commit into
mainfrom
fix/vignette-index-entry
Closed

docs(vignette): fix placeholder VignetteIndexEntry#124
ehrlinger wants to merge 1 commit into
mainfrom
fix/vignette-index-entry

Conversation

@ehrlinger

Copy link
Copy Markdown
Owner

The intro vignette (vignettes/ggRandomForests.qmd) shipped with the template-default \VignetteIndexEntry{Vignette's Title}, so CRAN's vignette list shows "Vignette's Title" instead of the real one. Its document title: was always correct — only the index entry was stale.

Fixed to \VignetteIndexEntry{Exploring Random Forests with ggRandomForests} (matches the document title). Verified the other three vignettes already have correct index entries; no other template placeholders remain.

Doc-only; rides in the next release (3.1.3).

🤖 Generated with Claude Code

The intro vignette's \VignetteIndexEntry was still the template default
('Vignette's Title'), so CRAN's vignette list showed that instead of the real
title. Set it to match the document title, 'Exploring Random Forests with
ggRandomForests'. The other three vignettes already have correct index entries.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@codecov

codecov Bot commented Jun 13, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.04%. Comparing base (fdec398) to head (fbe369b).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main     #124   +/-   ##
=======================================
  Coverage   87.04%   87.04%           
=======================================
  Files          44       44           
  Lines        3938     3938           
=======================================
  Hits         3428     3428           
  Misses        510      510           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes the Quarto vignette metadata for the package’s introductory vignette so CRAN’s vignette index displays the correct title instead of the template placeholder.

Changes:

  • Update \VignetteIndexEntry{...} in vignettes/ggRandomForests.qmd to match the document title (“Exploring Random Forests with ggRandomForests”).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

ehrlinger added a commit that referenced this pull request Jun 13, 2026
The originally-planned 3.1.2 content (fix #118 + the gg_beta_uvarpro/
gg_sdependent unsupervised varPro wrappers) lost its version number to the
gcc-UBSAN re-fix that shipped as 3.1.2. Re-cut here as 3.1.3.

- Merge main (v3.1.2): DESCRIPTION/NEWS reconciled to 3.1.3; #121's notes
  re-homed under a v3.1.3 heading above main's v3.1.2 (UBSAN) section.
- Fix the failing pkgdown build: add the 4 new exported topics
  (gg_beta_uvarpro, gg_sdependent, + plot.* ) to _pkgdown.yml's reference
  index (they were documented exports missing from the index).
- Fold in the vignette \VignetteIndexEntry fix (was the template placeholder
  'Vignette's Title') so 3.1.3 ships it; supersedes PR #124.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@ehrlinger ehrlinger requested a review from Copilot June 13, 2026 19:41

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

@ehrlinger

Copy link
Copy Markdown
Owner Author

Closing — the vignette \VignetteIndexEntry fix is folded into #121 (the dev-line PR with the #118 fix + unsupervised varPro wrappers). Will land on dev, not as a standalone 3.1.2-era main change.

@ehrlinger ehrlinger closed this Jun 13, 2026
@ehrlinger ehrlinger deleted the fix/vignette-index-entry branch June 13, 2026 20:47
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