Skip to content

OpMethod descriptions should omit method parameters #130

@gselzer

Description

@gselzer

By typing ops.descriptions("filter.gauss") I get the following OpMethodInfo description:

net.imagej.ops2.filter.gauss.Gaussians.defaultGaussRAI(net.imglib2.RandomAccessibleInterval<T>,java.util.concurrent.ExecutorService,double[],net.imglib2.outofbounds.OutOfBoundsFactory<T, net.imglib2.RandomAccessibleInterval<T>>,net.imglib2.RandomAccessibleInterval<T>)(
	 Inputs:
		net.imglib2.RandomAccessibleInterval<T> input1
		java.util.concurrent.ExecutorService input2
		double[] input3
		net.imglib2.outofbounds.OutOfBoundsFactory<T, net.imglib2.RandomAccessibleInterval<T>> input4?
	 Containers (I/O):
		net.imglib2.RandomAccessibleInterval<T> container1
)

I think that the parameters of the method severely impact readability, and are redundant with respect to the parameters. I understand that the parameters are vital for uniquely identifying the method, but the point of the description is to help the user understand the Op, and the parameters (on the method, anyways) don't aid in that.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions