Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove bskSim depreciated code #758

Merged
merged 2 commits into from
Aug 2, 2024

Conversation

schaubh
Copy link
Contributor

@schaubh schaubh commented Aug 2, 2024

  • Review: By commit
  • Merge strategy: Merge (no squash)

Description

The bskSim code contained depreciated variable naming for backwards compatibility.
The depreciation period ended July 30, 2024. This old code is now being removed.

Verification

Did a clean build of the documentation which worked as expected. But, the documentation can't use the very recent
sphinx tool version 8.x as the sphinx_rtd_theme style file is not yet compatible with this.

Documentation

Updated the optional package install requirements that sphinx 8.x is not yet supported.

Future work

None

schaubh added 2 commits August 2, 2024 13:57
The bskSim simulations were still providing access to variables with  'Wrap'  at the end of the
variable in case other simulations where using this.  Now only the new C module
naming convention is used.
The style file `sphinx_rtd_theme` we use is not yet compatible with sphinx 8.x.
@schaubh schaubh added the enhancement New feature or request label Aug 2, 2024
@schaubh schaubh requested a review from Mark2000 August 2, 2024 20:07
@schaubh schaubh self-assigned this Aug 2, 2024
@schaubh schaubh requested a review from a team as a code owner August 2, 2024 20:07
Copy link
Contributor

@Mark2000 Mark2000 left a comment

Choose a reason for hiding this comment

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

Straightforward changes, looks good. I’ll check if the sphinx version affects any of my code.

@schaubh schaubh merged commit 564d0c5 into develop Aug 2, 2024
3 checks passed
@schaubh schaubh deleted the feature/remove_BSK_sim_depreciated_code branch August 2, 2024 23:08
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