Update release notes and doc string

qutech · Mar 25, 2019 · c598466 · c598466
1 parent 47e45c6
commit c598466
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/ReleaseNotes.txt b/ReleaseNotes.txt
@@ -6,6 +6,7 @@
 - Pulse Templates:
     - `MappingPulseTemplate`:
         - Raise a ValueError if more than one inner channel is mapped to the same outer channel
+        - `allow_partial_parameter_mapping` is now True as a default. The default can be changed with the class variable `MappingPulseTemplate.ALLOW_PARTIAL_PARAMETER_MAPPING`.
 
 ## 0.3 ##
 

diff --git a/qupulse/pulses/mapping_pulse_template.py b/qupulse/pulses/mapping_pulse_template.py
@@ -28,6 +28,7 @@ class MappingPulseTemplate(PulseTemplate, ParameterConstrainer):
     constraining parameters by deriving from ParameterConstrainer"""
 
     ALLOW_PARTIAL_PARAMETER_MAPPING = True
+    """Default value for allow_partial_parameter_mapping of the __init__ method."""
 
     def __init__(self, template: PulseTemplate, *,
                  identifier: Optional[str]=None,
@@ -52,7 +53,7 @@ def __init__(self, template: PulseTemplate, *,
         :param measurement_mapping: mappings for other measurement names are inserted
         :param channel_mapping: mappings for other channels are auto inserted
         :param parameter_constraints:
-        :param allow_partial_parameter_mapping:
+        :param allow_partial_parameter_mapping: If None the value of the class variable ALLOW_PARTIAL_PARAMETER_MAPPING
         """
         PulseTemplate.__init__(self, identifier=identifier)
         ParameterConstrainer.__init__(self, parameter_constraints=parameter_constraints)