Skip to content

Commit a8fa2cb

Browse files
committed
fix: function comments
1 parent 96f1408 commit a8fa2cb

File tree

1 file changed

+3
-5
lines changed

1 file changed

+3
-5
lines changed

src/datasets/domain/useCases/GetDatasetVersionDiff.ts

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,10 @@ export class GetDatasetVersionDiff implements UseCase<DatasetVersionDiff> {
1010
}
1111

1212
/**
13-
* Returns a Dataset instance, given the search parameters to identify it.
14-
* TODO: should we allow DatasetNotNumberedVersion enum values for newVersionId and oldVersionId?
13+
* Returns a DatasetVersionDiff instance, which contains the differences between the two given versions.
1514
* @param {number | string} [datasetId] - The dataset identifier, which can be a string (for persistent identifiers), or a number (for numeric identifiers).
16-
* @param {string } [newVersionId] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value. If this parameter is not set, the default value is: DatasetNotNumberedVersion.LATEST
17-
* @param {string } [oldVersionId] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value. If this parameter is not set, the default value is: DatasetNotNumberedVersion.LATEST * @param {boolean} [includeDeaccessioned=false] - Indicates whether to consider deaccessioned versions in the dataset search or not. The default value is false
18-
* @returns {Promise<DatasetVersionDiff>}
15+
* @param {string } [newVersionId] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value.
16+
* @param {string } [oldVersionId] - The dataset version identifier, which can be a version-specific numeric string (for example, 1.0) or a DatasetNotNumberedVersion enum value.
1917
*/
2018
async execute(
2119
datasetId: number | string,

0 commit comments

Comments
 (0)