From f0a895262b5806d1d424df3e1203b64b6228a552 Mon Sep 17 00:00:00 2001 From: Adina Wagner Date: Thu, 30 Sep 2021 18:09:54 +0200 Subject: [PATCH 1/2] Fix command name: xnat-query -> xnat-query-files --- README.md | 4 ++-- docs/source/api.rst | 2 +- docs/source/cmd.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 005c610..567b1e9 100644 --- a/README.md +++ b/README.md @@ -20,8 +20,8 @@ imaging-based projects. Command(s) provided by this extension - `xnat-init` -- Initialize an existing dataset to track an XNAT project -- `xnat-update` -- Update an existing dataset of an XNAT project - +- `xnat-update` -- Update an existing dataset of an XNAT project; retrieve data from the tracked project +- `xnat-query-files` -- Query available files on an XNAT instance or project ## Installation diff --git a/docs/source/api.rst b/docs/source/api.rst index 98156ff..fc79dc5 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -3,7 +3,7 @@ Python API ========== -``datalad-xnat`` has three main commands that are exposed as functions via ``datalad.api`` and as methods of the ``Dataset`` class: ``xnat_init`` for [COMPLETE ME], ``xnat_update`` [COMPLETE ME], and ``xnat_query`` for [COMPLETE ME]. +``datalad-xnat`` has three main commands that are exposed as functions via ``datalad.api`` and as methods of the ``Dataset`` class: ``xnat_init`` for [COMPLETE ME], ``xnat_update`` [COMPLETE ME], and ``xnat_query-files`` for [COMPLETE ME]. Find out more about each command below. .. currentmodule:: datalad.api diff --git a/docs/source/cmd.rst b/docs/source/cmd.rst index c77914c..ade2736 100644 --- a/docs/source/cmd.rst +++ b/docs/source/cmd.rst @@ -3,7 +3,7 @@ Command line reference ====================== -``datalad-xnat`` has three main commands: ``xnat-init`` for [COMPLETE ME], ``xnat-update`` [COMPLETE ME], and ``xnat-query`` for [COMPLETE ME]. +``datalad-xnat`` has three main commands: ``xnat-init`` for [COMPLETE ME], ``xnat-update`` [COMPLETE ME], and ``xnat-query-files`` for [COMPLETE ME]. Find out more about each command below. .. toctree:: From 1a03540564ca8390fc4ed7f01ba52d8c8244cdd5 Mon Sep 17 00:00:00 2001 From: Adina Wagner Date: Thu, 30 Sep 2021 18:17:01 +0200 Subject: [PATCH 2/2] DOC: provide a base description for the commands --- docs/source/api.rst | 2 +- docs/source/cmd.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/api.rst b/docs/source/api.rst index fc79dc5..d34aa04 100644 --- a/docs/source/api.rst +++ b/docs/source/api.rst @@ -3,7 +3,7 @@ Python API ========== -``datalad-xnat`` has three main commands that are exposed as functions via ``datalad.api`` and as methods of the ``Dataset`` class: ``xnat_init`` for [COMPLETE ME], ``xnat_update`` [COMPLETE ME], and ``xnat_query-files`` for [COMPLETE ME]. +``datalad-xnat`` has three main commands that are exposed as functions via ``datalad.api`` and as methods of the ``Dataset`` class: ``xnat_init`` for configuring a dataset to track XNAT projects, ``xnat_update`` for updating and retrieving files from tracked XNAT projects, and ``xnat_query-files`` for querying available files on an XNAT server. Find out more about each command below. .. currentmodule:: datalad.api diff --git a/docs/source/cmd.rst b/docs/source/cmd.rst index ade2736..e690bd3 100644 --- a/docs/source/cmd.rst +++ b/docs/source/cmd.rst @@ -3,7 +3,7 @@ Command line reference ====================== -``datalad-xnat`` has three main commands: ``xnat-init`` for [COMPLETE ME], ``xnat-update`` [COMPLETE ME], and ``xnat-query-files`` for [COMPLETE ME]. +``datalad-xnat`` has three main commands: ``xnat-init`` for for configuring a dataset to track XNAT projects, ``xnat-update`` for updating and retrieving files from tracked XNAT projects, and ``xnat-query-files`` for for querying available files on an XNAT server. Find out more about each command below. .. toctree::