MREYE-LUMC / ZOSPy

Wrapper around the Zemax OpticStudio API. Provides a more pythonic and intuitive way to interact with the ZOS-API through python using a .NET connection.

https://zospy.readthedocs.io

MIT License

43 stars 11 forks source link

Add documentation option to PR template #44

Closed crnh closed 11 months ago

crnh commented 11 months ago

Proposed change

Add a documentation option under "Type of change".

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

Additional information

Python version: ...
OpticStudio version: ...

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.