Merge pull request #142 from datalad/doc-query-files

More accurate command overviews
datalad · Sep 30, 2021 · 16f30ab · 16f30ab
2 parents 2613a09 + 1a03540
commit 16f30ab
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git 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
@@ -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 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
@@ -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  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::