Adding details about group region and technology constraints

[ParticularlyPythonicBS]

closes #181

Summary by CodeRabbit

Release Notes

• Documentation
  • Added documentation on Group Region and Technology Constraints, explaining how constraint tables handle region and technology specifications, including supported values and applicable table behaviors.

[coderabbitai]

Warning

Rate limit exceeded

@ParticularlyPythonicBS has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 3 minutes and 35 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 3 minutes and 35 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 5179dd52-5150-4030-ab9c-d6d18042dfaa

📥 Commits

Reviewing files that changed from the base of the PR and between 576c69e and bcb65d8.

📒 Files selected for processing (1)

• docs/source/database.rst

Walkthrough

Documentation-only addition introducing a new section that explains how constraint tables perform summation across grouped regions and technologies, including allowed column values and supported table types.

Changes

Cohort / File(s)	Summary
Documentation Updates docs/source/database.rst	Added "Group Region and Technology Constraints" section detailing region aggregation behavior (single region, region subset with +, or global), supported constraint tables for region/technology grouping, and group definitions sourced from tech_group and tech_group_member tables.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title directly summarizes the main change: documentation about group region and technology constraints, matching the file modifications.
Linked Issues check	✅ Passed	The PR addresses issue #181 by adding documentation about group region constraints and exchange technology behavior with examples and clarifications as requested.
Out of Scope Changes check	✅ Passed	All changes are documentation-only additions related to group region and technology constraints, directly aligned with the linked issue requirements.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/group_region_constraints

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/source/database.rst`:
- Around line 109-164: Add a short reporter attribution line in the "Group
Region and Technology Constraints" section to credit idelder for identifying the
exchange-technology behavior; edit the paragraph(s) under that section header
(e.g., near the opening explanation of group regions/technology groups) to
append a single sentence such as “Reporter: idelder — identified the
exchange-technology behavior” (or similar wording), ensuring the attribution is
visible alongside the new section text.
- Around line 115-137: Update the "Group Regions" section in database.rst to
explicitly document the exchange-technology behavior from issue `#181`: state that
exchange-technology flows are included in grouped or "global" constraints only
if their exchange-technology key is explicitly present in the region string
(e.g., "east+west+<exchange_key>" or "global+<exchange_key>"), provide a short
example showing a grouped region that omits exchange flows versus one that
includes them, and add a brief note or caution so users know to append exchange
keys to region values when they intend to include exchange-technology flows in
limit_* tables.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 1bbf5534-bbb0-49a2-8249-540f1c2dcc5c

📥 Commits

Reviewing files that changed from the base of the PR and between 3ac6b18 and 576c69e.

📒 Files selected for processing (1)

• docs/source/database.rst

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!