Hotfix/store-touchdown-parameters by zacczakk · Pull Request #14 · 2phi/weac

zacczakk · 2025-08-14T10:31:43Z

Summary by CodeRabbit

Chores
- Bumped release version to 2.6.4 across package and citation metadata.
Documentation
- Updated documentation and demo notebook to reference v2.6.4; no functional changes.
Refactor
- Internal adjustment to retain computed thresholds during touchdown mode calculation; no change to user-visible behavior.

coderabbitai · 2025-08-14T10:31:50Z

Walkthrough

Incremented project version from 2.6.3 to 2.6.4 across metadata, docs, and demo notebook. In weac/mixins.py, calc_touchdown_mode now stores computed thresholds a1 and a2 on the instance (self.a1, self.a2) instead of using local variables; decision logic remains unchanged.

Changes

Cohort / File(s)	Summary
Version metadata bump `pyproject.toml`, `weac/__init__.py`, `CITATION.cff`, `docs/sphinx/conf.py`	Updated version from 2.6.3 to 2.6.4 in package metadata and docs config (`project.version`, `__version__`, citation `version`, Sphinx `release`).
Documentation/demo text update `demo/demo.ipynb`	Updated notebook markdown to reference release v2.6.4 (no code or execution changes).
Touchdown thresholds persistence `weac/mixins.py`	calc_touchdown_mode assigns a1/a2 to instance attributes (self.a1, self.a2) and uses them in comparisons; control flow unchanged.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Possibly related PRs

Bump version: 2.6.1 → 2.6.2 #11 — Similar version bump across metadata files; likely aligned release maintenance.

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

💡 Knowledge Base configuration:

MCP integration is disabled by default for public repositories
Jira integration is disabled by default for public repositories
Linear integration is disabled by default for public repositories

You can enable these settings in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between f0a1358 and 149632c.

📒 Files selected for processing (6)

CITATION.cff (1 hunks)
demo/demo.ipynb (1 hunks)
docs/sphinx/conf.py (1 hunks)
pyproject.toml (2 hunks)
weac/__init__.py (1 hunks)
weac/mixins.py (1 hunks)

👮 Files not reviewed due to content moderation or server errors (1)

demo/demo.ipynb

🔇 Additional comments (5)

CITATION.cff (1)

11-11: Version bump to 2.6.4 is consistent and correct.

Matches other project metadata updates.

docs/sphinx/conf.py (1)

13-13: Sphinx release updated to 2.6.4 — looks good.

Aligned with the package version.

weac/__init__.py (1)

14-14: version set to 2.6.4 — LGTM.

Consistent with the rest of the repo.

weac/mixins.py (1)

793-799: Stage selection bounds are correct and unambiguous.

A: a <= a1

B: a1 < a <= a2

C: a2 < a

No gaps or overlaps. Behavior unchanged aside from persisting thresholds.

pyproject.toml (1)

7-7: Project and bumpversion versions updated to 2.6.4 — consistent across files.

No issues spotted.

Also applies to: 80-80

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch hotfix/store-touchdown-parameters

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

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

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Status, Documentation and Community

Visit our Status Page to check the current availability of CodeRabbit.
Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Pull Request Overview

This PR implements a hotfix to store touchdown parameters a1 and a2 as instance attributes in the calc_touchdown_mode method, allowing these computed values to be accessible outside the method scope. The change also includes a version bump from 2.6.3 to 2.6.4 across all project files.

Store a1 and a2 as instance attributes instead of local variables
Bump project version to 2.6.4 across all configuration and documentation files

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
weac/mixins.py	Store touchdown parameters as instance attributes for external access
weac/init.py	Update package version to 2.6.4
pyproject.toml	Update project version and bump version configuration
docs/sphinx/conf.py	Update documentation release version
demo/demo.ipynb	Update notebook to reference new version
CITATION.cff	Update citation version

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.}

Copilot · 2025-08-14T10:32:49Z

            # Calculate stage transitions
-            a1 = self.calc_a1()
-            a2 = self.calc_a2()
+            self.a1 = self.calc_a1()


Storing computed values as instance attributes in a calculation method creates side effects that could lead to confusion. Consider returning these values as part of a tuple or storing them in a dedicated data structure to make the intent clearer.

Copilot · 2025-08-14T10:32:49Z

-            a1 = self.calc_a1()
-            a2 = self.calc_a2()
+            self.a1 = self.calc_a1()
+            self.a2 = self.calc_a2()


The assignment of computed values to instance attributes creates a side effect in this calculation method. This pattern can make the code harder to reason about and test, as the method now has multiple responsibilities.

zacczakk added 2 commits August 14, 2025 12:30

fix: Store touchdown parameters

d32f874

Bump version: 2.6.3 → 2.6.4

149632c

Copilot AI review requested due to automatic review settings August 14, 2025 10:31

zacczakk temporarily deployed to docs-deploy August 14, 2025 10:31 — with GitHub Actions Inactive

Copilot AI reviewed Aug 14, 2025

View reviewed changes

zacczakk merged commit bf5b6c2 into main Aug 14, 2025
8 of 9 checks passed

zacczakk deleted the hotfix/store-touchdown-parameters branch August 14, 2025 10:34

Navigation Menu

Uh oh!

Hotfix/store-touchdown-parameters - #14

Hotfix/store-touchdown-parameters#14
zacczakk merged 2 commits into
mainfrom
hotfix/store-touchdown-parameters

zacczakk commented Aug 14, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Aug 14, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Status, Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Copilot AI Aug 14, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

zacczakk commented Aug 14, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Aug 14, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Chat

Support

CodeRabbit Commands (Invoked using PR/Issue comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Status, Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

zacczakk commented Aug 14, 2025 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Aug 14, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)