Skip to content

Commit ec158ff

Browse files
committed
Docstring conventions
1 parent 4333086 commit ec158ff

1 file changed

Lines changed: 8 additions & 9 deletions

File tree

src/imcflibs/imagej/labelimage.py

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -100,27 +100,26 @@ def cookie_cut_labels(label_image_ref, label_image_to_relate):
100100
def relate_label_images(outer_label_imp, inner_label_imp):
101101
"""Relate label images, giving the same label to objects belonging together.
102102
103-
Given two label images, this function will create a new label image
104-
with the same labels as the reference image, but with the objects
105-
of the second image using the 3D Association plugin from the
106-
3DImageJSuite.
103+
Given two label images, this function will create a new label image with the
104+
same labels as the reference image, but with the objects of the second image
105+
using the 3D Association plugin from the 3DImageJSuite.
107106
108107
Parameters
109108
----------
110109
outer_label_imp : ij.ImagePlus
111-
The outer label image
110+
The outer label image.
112111
inner_label_imp : ij.ImagePlus
113-
The inner label image
112+
The inner label image.
114113
115114
Returns
116115
-------
117116
related_inner_imp : ij.ImagePlus
118-
The related inner label image
117+
The related inner label image.
119118
120119
Notes
121120
-----
122-
Unlike `cookie_cut_labels`, this should work with touching labels by
123-
using MereoTopology algorithms.
121+
Unlike `cookie_cut_labels`, this should work with touching labels by using
122+
MereoTopology algorithms.
124123
"""
125124

126125
outer_label_imp.show()

0 commit comments

Comments
 (0)