Skip to content

Commit

Permalink
Fine-tune rename_labels #335 (#340)
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr authored Mar 15, 2022
1 parent 24f3a1a commit 1bb153c
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions rename_labels.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "rename_labels",
"summary": "Rename dimension labels",
"description": "Renames the labels of the specified dimension in the data cube from `source` to `target`.\n\nIf the array for the source labels is empty (the default), the dimension labels are expected to be enumerated with zero-based numbering (0,1,2,3,...) so that the dimension labels directly map to the indices of the array specified for the parameter `target`. The number of the source and target labels must be equal. Otherwise, the exception `LabelMismatch` is thrown.\n\nThis process doesn't change the order of the labels and their corresponding data.",
"description": "Renames the labels of the specified dimension in the data cube from `source` to `target`.\n\nIf the array for the source labels is empty (the default), the dimension labels are expected to be enumerated with zero-based numbering (0,1,2,3,...) so that the dimension labels directly map to the indices of the array specified for the parameter `target`. Otherwise, the number of the source and target labels must be equal. If none of these requirements is fulfilled, the `LabelMismatch` exception is thrown.\n\nThis process doesn't change the order of the labels and their corresponding data.",
"categories": [
"cubes"
],
Expand All @@ -23,7 +23,7 @@
},
{
"name": "target",
"description": "The new names for the labels. If a target dimension label already exists in the data cube, a `LabelExists` exception is thrown.",
"description": "The new names for the labels.\n\nIf a target dimension label already exists in the data cube, a `LabelExists` exception is thrown.",
"schema": {
"type": "array",
"items": {
Expand All @@ -36,7 +36,7 @@
},
{
"name": "source",
"description": "The names of the labels as they are currently in the data cube. The array defines an unsorted and potentially incomplete list of labels that should be renamed to the names available in the corresponding array elements in the parameter `target`. By default, the array is empty so that the dimension labels in the data cube are expected to be enumerated.\n\nIf the dimension labels are not enumerated and the given array is empty, the `LabelsNotEnumerated` exception is thrown. If one of the source dimension labels doesn't exist, the `LabelNotAvailable` exception is thrown.",
"description": "The original names of the labels to be renamed to corresponding array elements in the parameter `target`. It is allowed to only specify a subset of labels to rename, as long as the `target` and `source` parameter have the same length. The order of the labels doesn't need to match the order of the dimension labels in the data cube. By default, the array is empty so that the dimension labels in the data cube are expected to be enumerated.\n\nIf the dimension labels are not enumerated and the given array is empty, the `LabelsNotEnumerated` exception is thrown. If one of the source dimension labels doesn't exist, the `LabelNotAvailable` exception is thrown.",
"schema": {
"type": "array",
"items": {
Expand Down

0 comments on commit 1bb153c

Please sign in to comment.