Skip to content

Docs: README and the docstring - #35

Merged
jerome-white merged 1 commit into
masterfrom
issue-13-docs
Oct 21, 2026
Merged

jerome-white merged 1 commit into
masterfrom
issue-13-docs

Conversation

@jerome-white

Copy link
Copy Markdown
Owner

Closes #13

What this does

README (restructured; the threads and reproducibility section is unchanged):

Docstring of randomized_tukey_hsd (the only change to src/, text only): lists every error it throws (B, fewer than two systems, NaN, DimensionMismatch), says what p = 0 means, and adds a short runnable example. The ragged line wrapping from the rng edits is fixed.

Decisions

Verification

  • The docstring example runs (pvalue 0.0048 for A against C at B = 10 000, seed 1).
  • The Pkg.add(url=...) install and a call, in a clean environment.
  • The CLI usage and output columns, run on test/data/tiny.csv.
  • ] test passes (96 pass + 1 deliberately broken); 80 columns checked.
  • Not checked: the rendered Markdown on GitHub; the anchor links (#missing-scores, #threads-and-reproducibility) rely on GitHub's usual heading ids.

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@jerome-white jerome-white self-assigned this Oct 21, 2026
@jerome-white
jerome-white merged commit b9627e1 into master Oct 21, 2026
4 checks passed
@jerome-white
jerome-white deleted the issue-13-docs branch October 21, 2026 18:35
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: README usage and docstrings

1 participant