Skip to content

docs: add ?kit package page and cross-platform install/threading docs - #99

Merged
davidbudzynski merged 1 commit into
fastverse:masterfrom
davidbudzynski:docs/90-kit-package-page
Oct 30, 2026
Merged

davidbudzynski merged 1 commit into
fastverse:masterfrom
davidbudzynski:docs/90-kit-package-page

Conversation

@davidbudzynski

Copy link
Copy Markdown
Collaborator

Closes #90.

Summary

  • Add man/kit-package.Rd so help("kit") shows a package page.
  • Document which functions use OpenMP, how kit.nThread works, and the no-OpenMP fallback.
  • Add OpenMP installation notes for Linux, macOS, and Windows.
  • Add a "Platforms" section for the shareData() POSIX/Windows difference.
  • Add library(kit) to the first README example.
  • Add a NEWS entry.

The new text uses ASD-STE100 style: short sentences, active voice, and simple words.

Test

  • R CMD build .
  • R CMD check --no-manual kit_0.0.22.tar.gz -> 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 (4d88a82).
⚠️ Report is 126 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      #99      +/-   ##
==========================================
- 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/90-kit-package-page branch from b1eb1de to 4d88a82 Compare October 30, 2026 19:26
@davidbudzynski
davidbudzynski merged commit d76f9ad 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: add ?kit package page and cross-platform install/threading docs

2 participants