Skip to content

feat: use consistent iterable var naming conventions instead of the g…#103

Merged
alexanderharding merged 1 commit into
mainfrom
iterable-var-naming
May 24, 2026
Merged

feat: use consistent iterable var naming conventions instead of the g…#103
alexanderharding merged 1 commit into
mainfrom
iterable-var-naming

Conversation

@alexanderharding

@alexanderharding alexanderharding commented May 24, 2026

Copy link
Copy Markdown
Owner

…eneric 'iterables'

Summary by CodeRabbit

  • Chores

    • Bumped @observable/all package to version 0.22.0
    • Bumped for-of package to version 0.10.0
  • Refactor

    • Refined parameter naming conventions in all and for-of functions for improved consistency across the API

Review Change Stack

@alexanderharding alexanderharding self-assigned this May 24, 2026
@coderabbitai

coderabbitai Bot commented May 24, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 35a8d0c0-8c7c-461e-8fc5-02ea039de922

📥 Commits

Reviewing files that changed from the base of the PR and between 1cb80ee and ec04228.

📒 Files selected for processing (5)
  • all/deno.json
  • all/mod.test.ts
  • all/mod.ts
  • for-of/deno.json
  • for-of/mod.ts

📝 Walkthrough

Walkthrough

The PR updates parameter naming conventions and version numbers across two packages: all and for-of. The all function signature and implementation rename the parameter from iterable to observables while refactoring internal variable handling, and its test is updated accordingly. The for-of function similarly renames its parameter from iterable to values. Package versions are bumped to 0.22.0 and 0.10.0 respectively.

Changes

all Package Parameter and Implementation Refactoring

Layer / File(s) Summary
Iterable overload implementation refactor
all/mod.ts, all/mod.test.ts, all/deno.json
The all<Value> iterable overload parameter is renamed from iterable to observables; the implementation refactors internal handling to use a boundObservables variable through the subscription logic. The empty-iterable test is updated to use the new parameter name and inline iterator style. Version is bumped to 0.22.0.

for-of Package Parameter Refactoring

Layer / File(s) Summary
Iterable overload parameter rename
for-of/mod.ts, for-of/deno.json
The forOf<Value> iterable overload parameter is renamed from iterable to values in both signature and implementation. Version is bumped to 0.10.0.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

Poem

🐰 Parameters find their truest names,
observables and values bright,
Each function speaks more clear and plain,
Versions climb to mark the light.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: adopting consistent variable naming conventions for iterables instead of generic 'iterables' naming, which is reflected across all modified files.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch iterable-var-naming

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

@alexanderharding alexanderharding merged commit ff7a61e into main May 24, 2026
2 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