|Home > Iris APIs > Instance registry, instance discovery, and interface discovery API > Naming conventions for new functions|
When adding new functions that replace or extend existing functions, use the following naming conventions.
Assuming the existing function is called
breakpoint_set(), and a new non-orthogonal feature,
foo, must be added, which cannot be supported by extending
breakpoint_set() with optional arguments, for example
breakpoint_set(enableFoo=True, …), new versions of this function should be named, in the following order, from most to least preferred:
Foois a suitable description of the new non-orthogonal feature. If the feature is orthogonal to existing functionality, an argument
enableFoo=Trueshould be added to the existing
breakpoint_set()function, rather than introducing a new function.
breakpoint_set, but has a better interface with incompatible arguments or incompatible return value and therefore enhancing the argument list or return value is not an option.
See also 5.2 Naming conventions for general naming conventions.