Skip to content

docs: finish cluster_weights->cluster_counts terminology cleanup#107

Merged
FBumann merged 1 commit into
mainfrom
followup/v4-terminology-cleanup
Jul 23, 2026
Merged

docs: finish cluster_weights->cluster_counts terminology cleanup#107
FBumann merged 1 commit into
mainfrom
followup/v4-terminology-cleanup

Conversation

@FBumann

@FBumann FBumann commented Jul 23, 2026

Copy link
Copy Markdown
Owner

Follow-up to #105 addressing review findings.

Fixed (still-valid terminology leftovers)

The cluster_weightscluster_counts rename in #105 left a few user-facing spots still saying "weight":

  • getting-started.ipynb"Cluster weights (days each represents):" print label and to_dataframe("weight") column → count.
  • multi-dim.ipynb — prose "Cluster weights, …" and to_dataframe("weight") column → count.
  • test_parametrized.pytest_cluster_occurrences_matches_weightstest_cluster_occurrences_matches_counts (implementation unchanged).

Skipped (with reason)

The docstring-section suggestions (add Returns: to the cluster_weights / n_clusters properties; add Args:/Returns:/Raises: to _cluster_counts and _validate_no_cluster_config_weights) were not applied. The codebase convention is prose one-liners for trivial @property accessors and private helpers, with structured Google-style sections used only on the public aggregate() and public methods that take real parameters. Adding sections to these would break that local consistency.

Validation

  • test/test_parametrized.py -k cluster_occurrences → 21 passed (tsam 3.4.x).
  • Both notebooks re-parse as valid JSON; ruff check / ruff format clean; pre-commit hooks pass.

🤖 Generated with Claude Code

Follow-up to #105. Rename the leftover user-facing "weight" labels and
column names to "count", and the matching test, so nothing displays the
old term:

- getting-started.ipynb: "Cluster weights" print label and the
  to_dataframe("weight") column -> "count".
- multi-dim.ipynb: prose "Cluster weights" and to_dataframe("weight")
  column -> "count".
- test_parametrized: test_cluster_occurrences_matches_weights ->
  ..._matches_counts.

Skipped the reviewer's docstring-section suggestions (Returns on the
cluster_weights/n_clusters properties; Args/Returns/Raises on
_cluster_counts and _validate_no_cluster_config_weights): the codebase
convention is prose one-liners for trivial properties and private
helpers, with structured sections only on the public aggregate() and
public methods that take real parameters. Adding them would break that
local consistency.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@FBumann, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 36 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: c5c257c3-47d5-41fe-a648-65dca009929c

📥 Commits

Reviewing files that changed from the base of the PR and between 6cd9f5d and 88e00e6.

📒 Files selected for processing (3)
  • docs/examples/getting-started.ipynb
  • docs/examples/multi-dim.ipynb
  • test/test_parametrized.py
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch followup/v4-terminology-cleanup

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@FBumann
FBumann merged commit cd94979 into main Jul 23, 2026
9 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.

1 participant