Skip to content

Rename B to trials - #45

Merged
jerome-white merged 4 commits into
masterfrom
issue-39-trials
Oct 21, 2026
Merged

jerome-white merged 4 commits into
masterfrom
issue-39-trials

Conversation

@jerome-white

Copy link
Copy Markdown
Owner

Closes #39. Part of #38.

What this does

B is renamed trials (formerly B; Carterette and Sakai write it as B), everywhere:

  • Library: randomized_tukey_hsd(...; trials, systems). The error is now trials must be positive, got .... Internally the variable is trials too; the local that held "the number of trials at least as large as the difference" is renamed exceeding so the two do not clash. Docstring updated.
  • CLI: --trials N, -n N and --B N are the same option (dest_name = "trials"); --help shows -n, --trials, --B TRIALS; the missing-option error now reads required option --trials was not provided. The settings message prints trials (it used to print B).
  • Tests, benchmarks and the README use the new name. benchmark/randomized_tukey.jl prints a trials column header. The tables already recorded in benchmark/README.md keep their B header, with a note at the top saying B there is trials.

Decisions

  • No deprecation of the library keyword. The version is 0.1.0-DEV and nothing depends on it, so B= simply no longer exists (calling with it is a MethodError for the missing trials).
  • The CLI alias is silent. --B works without a warning. Say if you want it to warn, and when it should go.
  • No NEWS.md started here. The README line for trials says it was called B before ("called B in the literature and in earlier versions of this package") and the benchmark README notes the old header. A NEWS.md is the question left open on Rename B to trials (library keyword and CLI option) #39 and Neutral vocabulary: blocks and treatments in docs and output #42.
  • Not renamed: the B in test/reference/ text that describes Sakai's tool (his recommendation of B between 1000 and 5000) and B as a system name in the fixtures.

Verification

  • ] test: 111 pass + 1 deliberately broken at 1 and 4 threads.
  • benchmark/snapshot.jl output is byte-identical to before the rename.
  • CLI: --trials 500, -n 500 and --B 500 give identical output with --seed 1, identical to the old --B 500 --seed 1 output; omitting it gives the error above.
  • 80 columns checked.

🤖 Generated with Claude Code

@jerome-white jerome-white self-assigned this Oct 21, 2026
jerome-white and others added 4 commits October 22, 2026 01:14
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@jerome-white
jerome-white merged commit 881eb6f into master Oct 21, 2026
4 checks passed
@jerome-white
jerome-white deleted the issue-39-trials branch October 21, 2026 19:46
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.

Rename B to trials (library keyword and CLI option)

1 participant