Deprecation policy

The Luceda Photonics Design Platform is continuously upgraded and improved. This means that sometimes we choose to deprecate a part of the API and replace it with new functionality. In some cases, functionality that is barely used in the field is removed to reduce complexity, or pushed to a separate API.

At Luceda, we find it important to handle this with a lot of care, ensuring smooth migration of your code.

Timing of deprecations

Deprecated features are officially removed in the first major release of each year (typically version 20xx.03). This applies only to features that have been marked as deprecated for at least one year, spanning four main releases (excluding bugfix releases). As a result, you will always have a minimum of one year to update your code and transition to the new functionality.

Documentation of deprecations

Deprecated features are communicated and documented through the following methods:

• Runtime Warnings

  When running a script, IPKISS generates a warning indicating the deprecated feature. These warnings are always visible but do not halt execution, urging you to update your code. If you require stricter handling, e.g. if you are developing a Design Kit, you can configure these warnings to be treated as errors (halting the program). See Logging and errors for more information.

• Changelog Entries

  The Changelog lists all deprecation along with the planned removal date (at least one year later).

• Backward Compatibility Notes

  For each software release version, the Summary per version page provides detailed backward compatibility notes, including instructions on how to update your code, when applicable. The changelog will refer to the relevant part.