DOC: provide a base description for the commands

datalad · Sep 30, 2021 · 1a03540 · 1a03540
1 parent f0a8952
commit 1a03540
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
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-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
@@ -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::