Add docstring to report and update README

UtrechtUniversity · Feb 17, 2025 · 0d4b041 · 0d4b041
1 parent 6a09bca
commit 0d4b041
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -87,12 +87,16 @@ OK
 
 ### yreport\_datapackageinfo
 
-Shows an extended data package report of each data package in the vault.
+Shows an extended data package report for each data package in the vault that includes
+path, size, publication status and date, README file, license, data access type, and
+metadata schema. The output is in CSV format.
 
 ```
 usage: yreport_datapackageinfo [-y {1.7,1.8,1.9,1.10}] [--help] [-h]
 
-Shows an extended data package report of each data package in the vault.
+Shows an extended data package report for each data package in the vault that includes
+path, size, publication status and date, README file, license, data access type, and
+metadata schema. The output is in CSV format.
 
 options:
   -y {1.7,1.8,1.9,1.10}, --yoda-version {1.7,1.8,1.9,1.10}

diff --git a/yclienttools/reportdatapackageinfo.py b/yclienttools/reportdatapackageinfo.py
@@ -1,3 +1,8 @@
+'''Shows an extended data package report for each data package in the vault that includes
+   path, size, publication status and date, README file, license, data access type, and
+   metadata schema. The output is in CSV format.
+'''
+
 import argparse
 import sys
 import csv