Skip to content

docs: clarify that p* functions are row-wise, not OpenMP-parallel - #97

Merged
davidbudzynski merged 1 commit into
fastverse:masterfrom
davidbudzynski:docs/88-parallel-functions
Oct 30, 2026
Merged

davidbudzynski merged 1 commit into
fastverse:masterfrom
davidbudzynski:docs/88-parallel-functions

Conversation

@davidbudzynski

Copy link
Copy Markdown
Collaborator

Closes #88.

What changed

  • README.md: renamed "Parallel Statistical Functions" to "Row-wise Statistical Functions". Added a note that "parallel" in the p* names means combining several vectors, not multi-threading. Named the five functions that can use OpenMP.
  • vignettes/introduction.Rmd: removed the false claim that psum, pmean, and pfirst use OpenMP. The vignette now says the p* functions are single-threaded C code and names iif(), nswitch(), vswitch(), psort(), and charToFact() as the OpenMP functions.
  • man/psum.Rd: added the same clarification to \description{}.
  • _pkgdown.yml: updated the reference section title and description.

No code, tests, or function behavior changed.

Test plan

  • tools::checkRd("man/psum.Rd") passes.
  • Vignette renders with rmarkdown::render().
  • R CMD check --no-manual on the built tarball: Status: OK.

@codecov-commenter

codecov-commenter commented Oct 30, 2026 •

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.76%. Comparing base (99413b6) to head (210a700).
⚠️ Report is 122 commits behind head on master.
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##           master      #97      +/-   ##
==========================================
- Coverage   98.01%   96.76%   -1.25%     
==========================================
  Files          13       14       +1     
  Lines        5083     5136      +53     
==========================================
- Hits         4982     4970      -12     
- Misses        101      166      +65     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@davidbudzynski
davidbudzynski force-pushed the docs/88-parallel-functions branch from d84e27d to 210a700 Compare October 30, 2026 19:08
@davidbudzynski
davidbudzynski merged commit 6fd02e7 into fastverse:master Oct 30, 2026
11 checks passed
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.

docs: psum() and the other p* functions are not OpenMP-parallel

2 participants