Deprecate

[jvonmuralt]

Summary by CodeRabbit

• Documentation
  • Added deprecation notice to README indicating the standalone package will no longer be maintained starting with Newton 1.3. Users are directed to migrate actuator usage to the consolidated newton.actuators location with updated migration guidance provided.

[coderabbitai]

📝 Walkthrough

Walkthrough

The README is updated with a deprecation notice replacing the previous beta development disclaimer. The notice explains that starting with Newton 1.3, actuators are created exclusively from newton.actuators and this standalone package will no longer be maintained, with links to migration resources.

Changes

Documentation Deprecation

Layer / File(s)	Summary
Deprecation Notice README.md	Beta disclaimer replaced with deprecation notice directing users to Newton 1.3 integrated actuators API and providing concept and API reference links.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

🐰 The package bids farewell with grace,
"Newton 1.3's the proper place!"
Actuators migrate to their new home,
No longer standalone to roam,
The docs now gently guide the way.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Deprecate' is vague and generic, lacking specificity about what is being deprecated or the scope of changes.	Use a more descriptive title that specifies what is being deprecated, such as 'Deprecate newton-actuators package' or 'Add deprecation notice for newton-actuators'.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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 unit tests (beta)

• Create PR with unit tests

---

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]

🧹 Nitpick comments (1)

README.md (1)

4-7: ⚡ Quick win

Clarify the supported compatibility window in the deprecation notice.

Please add one explicit sentence for legacy users (e.g., “Use this package only with Newton versions below 1.3”). Right now, the deprecation block and the remaining install/usage sections can read as conflicting guidance.

Proposed wording tweak

 > **⚠️ Deprecation Notice:** Starting with [Newton](https://github.com/newton-physics/newton) 1.3, actuators are created in and used exclusively from Newton's built-in `newton.actuators` module. This standalone `newton-actuators` package will no longer be maintained. Please migrate:
+> For legacy projects on Newton < 1.3, this package remains usable as-is, but no further updates are planned.
 >
 > - Concepts guide: https://newton-physics.github.io/newton/latest/concepts/actuators.html
 > - API reference: https://newton-physics.github.io/newton/latest/api/newton_actuators.html

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 4 - 7, Update the deprecation block in README.md to
explicitly state the supported compatibility window by adding a short sentence
such as “Use this package only with Newton versions below 1.3.”; reference the
existing deprecation text that mentions Newton 1.3 and newton.actuators and
append the compatibility clarification so readers know the standalone
newton-actuators package is only for legacy Newton <1.3 users.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Nitpick comments:
In `@README.md`:
- Around line 4-7: Update the deprecation block in README.md to explicitly state
the supported compatibility window by adding a short sentence such as “Use this
package only with Newton versions below 1.3.”; reference the existing
deprecation text that mentions Newton 1.3 and newton.actuators and append the
compatibility clarification so readers know the standalone newton-actuators
package is only for legacy Newton <1.3 users.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: de5a7b3a-2fa7-4396-9db2-420ca698d8ea

📥 Commits

Reviewing files that changed from the base of the PR and between b2bcb65 and 47090e9.

📒 Files selected for processing (1)

• README.md