Skip to content

Commit fc67169

Browse files
committed
Read the Docs
1 parent 367e48d commit fc67169

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/source/usage.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Parameters
2323
- ``multiple_files`` (bool, default=False): If True, the OpenMINDS data will be saved into multiple files within the specified output_path.
2424
- ``include_empty_properties`` (bool, default=False): If True, includes all the openMINDS properties with empty values in the final output. Otherwise includes only properties that have a non `None` value.
2525
- ``quiet`` (bool, default=False): If True, suppresses warnings and the final report output. Only prints success messages.
26-
- ``short_name`` (str or bool, default=None): A short name for this dataset. If set to a string, it will be used as the dataset's short name. If set to False, a short name will be assigned automatically. If None, the user will be prompted to enter one during conversion.
26+
- ``short_name`` (str or bool, default=None): A short name for this dataset. If set to a string, it will be used as the dataset's short name. If set to ``False``, a short name will be assigned automatically. If ``None``, the user will be prompted to enter one during conversion.
2727

2828
Returns
2929
#######
@@ -47,7 +47,7 @@ This function is also accessible via a command-line interface using the `click`
4747

4848
.. code-block:: console
4949
50-
Usage: bids2openminds [OPTIONS] INPUT_PATH
50+
Usage: bids2openminds INPUT_PATH [OPTIONS]
5151
5252
Arguments:
5353
input-path Path to the BIDS directory.

0 commit comments

Comments
 (0)