Skip to content

Commit 451f84c

Browse files
committed
Docstring syntax of usage examples
1 parent a17e0a9 commit 451f84c

1 file changed

Lines changed: 5 additions & 7 deletions

File tree

src/imcflibs/imagej/bdv.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1656,18 +1656,17 @@ def fuse_dataset_bdvp(
16561656
16571657
Examples
16581658
--------
1659-
Typical usage examples (doctest-style):
16601659
1661-
Example 1 - basic export using a CommandService instance available as
1662-
``command``::
1660+
Example 1 - simple export using a CommandService instance available as
1661+
`command`, using the default options and placing the output next to the
1662+
input xml:
16631663
16641664
>>> #@ CommandService command
16651665
>>> xml_input = "/path/to/project.xml"
1666-
>>> # run with default options, output placed next to the input xml
16671666
>>> fuse_dataset_bdvp(xml_input, command)
16681667
1669-
Example 2 - explicit options (custom output path, specific channels,
1670-
no interpolation, override z ratio)::
1668+
Example 2 - explicit options using a custom output path, specific channels,
1669+
disabling interpolation and overriding the z-ratio:
16711670
16721671
>>> #@ CommandService command
16731672
>>> xml_input = "/path/to/project.xml"
@@ -1686,7 +1685,6 @@ def fuse_dataset_bdvp(
16861685
... use_interpolation=False,
16871686
... )
16881687
"""
1689-
16901688
file_info = pathtools.parse_path(project_path)
16911689

16921690
if not result_path:

0 commit comments

Comments
 (0)