Skip to content

docs: plain-English pass over psort, charToFact, vswitch, psum, and topn - #100

Merged
davidbudzynski merged 1 commit into
fastverse:masterfrom
davidbudzynski:docs/91-plain-english
Oct 30, 2026
Merged

davidbudzynski merged 1 commit into
fastverse:masterfrom
davidbudzynski:docs/91-plain-english

Conversation

@davidbudzynski

Copy link
Copy Markdown
Collaborator

Summary

  • Rewrote the psort(), charToFact(), vswitch()/nswitch(), psum() family, and topn() help pages in short, plain sentences.
  • Documented nThread = getOption("kit.nThread"), locale and encoding behavior, the psort() non-character fallback, and R's real long-vector limits (2^52 on 64-bit builds).
  • Split the topn() output documentation into short paragraphs and documented the actual fallback and long-vector memory behavior.

Closes #91.

Checks

  • tools::checkRd() passes for all five changed files.
  • git diff --check passes.

@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 (22abcd3).
⚠️ Report is 128 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     #100      +/-   ##
==========================================
- 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 merged commit ce4d7eb 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: plain-English pass over psort, charToFact, vswitch, psum, and topn

2 participants