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

Fixed set_surface for object surface #102

Merged
merged 1 commit into from
Dec 23, 2024
Merged

Fixed set_surface for object surface #102

merged 1 commit into from
Dec 23, 2024

Conversation

LucVV
Copy link
Contributor

@LucVV LucVV commented Dec 18, 2024

Proposed change

The surface parameter of set_surface currrely allows "Image", "Objective" or an integer. Most analyses however ask the user for "Object" rather than "Objective" for the surface parameter, causing a error when the surface is supplies. This PR fixes that by also allowing "Object".

Type of change

  • Example (a notebook demonstrating how to use ZOSPy for a specific application)
  • Bugfix (non-breaking change which fixes an issue)
  • New analysis (a wrapper around an OpticStudio analysis)
  • New feature (other than an analysis)
  • Breaking change (fix/feature causing existing functionality to break)
  • Code quality improvements to existing code or addition of tests
  • Documentation (improvement of either the docstrings or the documentation website)

Additional information

  • Python version: 3.11
  • OpticStudio version: 20.3.2

Related issues

Checklist

  • I have followed the contribution guidelines
  • The code has been linted, formatted and tested locally using tox.
  • Local tests pass. Please fix any problems before opening a PR. If this is not possible, specify what doesn't work and why you can't fix it.
  • I added new tests for any features contributed, or updated existing tests.
  • I updated CHANGELOG.md with my changes (except for refactorings and changes in the documentation).

If you contributed an analysis:

  • I did not use AttrDicts for the analysis result data (please use dataclasses instead).

If you contributed an example:

  • I contributed my example as a Jupyter notebook.

@LucVV LucVV added the skip changelog It is not necessary to update the changelog for this PR label Dec 18, 2024
@LucVV LucVV requested a review from crnh December 18, 2024 10:28
Copy link
Collaborator

@crnh crnh left a comment

Choose a reason for hiding this comment

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

Great! Thanks for noticing this!

@crnh crnh merged commit c1e77d6 into v2.0.0 Dec 23, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changelog It is not necessary to update the changelog for this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants