Skip to content

remove deprecated multiSphereVector swig interface#1322

Merged
schaubh merged 3 commits intodevelopfrom
feature/remove__MultiSphereVector
Mar 12, 2026
Merged

remove deprecated multiSphereVector swig interface#1322
schaubh merged 3 commits intodevelopfrom
feature/remove__MultiSphereVector

Conversation

@schaubh
Copy link
Contributor

@schaubh schaubh commented Mar 11, 2026

  • Tickets addressed: bsk-1321
  • Review: By commit
  • Merge strategy: Merge (no squash)

Description

This branch completes removal of long-deprecated MultiSphere* compatibility usage in Vizard SWIG bindings and cleanup in examples/docs.

Changes included:

  • Removed deprecated mod.MultiSphereVector alias wrapper from src/simulation/vizard/vizInterface/vizInterface.i.
  • Removed deprecated mod.MultiSphere and mod.MultiSphereInfo alias wrappers from src/simulation/vizard/vizInterface/vizInterface.i.
  • Removed deprecated-API exercise code and related warning/deprecated imports from examples/scenarioDebrisReorbitET.py.
  • Updated deprecation helper docs example to generic placeholder names in src/architecture/_GeneralModuleFiles/swig_deprecated.i.
  • Added release-note snippets:
    • docs/source/Support/bskReleaseNotesSnippets/1320-remove-multispherevector-alias.rst
    • docs/source/Support/bskReleaseNotesSnippets/1321-remove-multisphere-aliases.rst

Verification

Validated with targeted automated test:

  • .venv/bin/pytest -q src/tests/test_scenarioDebrisReorbitET.py
  • Result: 1 passed in 2.23s

Reference checks:

  • Searched for deprecated wrapper definitions and MultiSphereVector usage.
  • No remaining runtime code references to mod.MultiSphere = _DeprecatedWrapper or mod.MultiSphereInfo = _DeprecatedWrapper.
  • MultiSphereVector now appears only in release-note snippet text.

No tests were added/updated because this PR removes deprecated compatibility paths and does not introduce new functional behavior.

Documentation

Documentation updates in this PR:

  • Added two release-note snippets under docs/source/Support/bskReleaseNotesSnippets/ (per Basilisk PR policy).
  • Updated swig_deprecated.i usage example text to avoid referencing removed aliases.

No direct edit was made to docs/source/Support/bskReleaseNotes.rst.

Future work

None

@schaubh schaubh requested a review from andrewmorell March 11, 2026 01:26
@schaubh schaubh self-assigned this Mar 11, 2026
@schaubh schaubh requested a review from a team as a code owner March 11, 2026 01:26
@schaubh schaubh added the enhancement New feature or request label Mar 11, 2026
@schaubh schaubh added this to Basilisk Mar 11, 2026
@schaubh schaubh moved this to 👀 In review in Basilisk Mar 11, 2026
Copy link
Contributor

@andrewmorell andrewmorell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Out of curiosity would it not make sense in the future to combine those two release notes snippets into one snippet, or are you wanting to credit different tickets?

@schaubh schaubh force-pushed the feature/remove__MultiSphereVector branch from 9ba3176 to f93557e Compare March 11, 2026 13:33
@schaubh
Copy link
Contributor Author

schaubh commented Mar 11, 2026

I could have combined them. I did the fixes in two steps and ended up with two notes. Once I push BSK v2.10.0 this all goes away anyway.

@schaubh schaubh merged commit d232829 into develop Mar 12, 2026
7 checks passed
@schaubh schaubh deleted the feature/remove__MultiSphereVector branch March 12, 2026 16:23
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Basilisk Mar 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants