Skip to content

Commit 7f627bf

Browse files
jamestwilkinsonMariusWirtz
authored andcommitted
Improve comments for legacy subset_name support (to close #1302)
1 parent 1c3b02b commit 7f627bf

1 file changed

Lines changed: 2 additions & 1 deletion

File tree

TM1py/Services/SubsetService.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -214,11 +214,12 @@ def get_element_names(
214214
:param dimension_name: Name of the dimension.
215215
:param hierarchy_name: Name of the hierarchy.
216216
:param subset: Subset name (str) or Subset object.
217+
:param subset_name: (legacy) subset name, supported for backwards compatibility.
217218
:param private: Whether the subset is private.
218219
:param kwargs: Additional arguments.
219220
:return: List of element names.
220221
"""
221-
# backward compatibility for subset_name
222+
# backward compatibility for legacy 'subset_name' parameter (Issue #1302)
222223
if "subset_name" in kwargs:
223224
if subset is not None:
224225
raise ValueError("Only one parameter 'subset' or 'subset_name' may be provided.")

0 commit comments

Comments
 (0)