Skip to content

Commit

Permalink
Merge pull request #803 from kordejong/gh784
Browse files Browse the repository at this point in the history
Add docstring to uniform
  • Loading branch information
kordejong authored Feb 4, 2025
2 parents c01f2db + 35f1914 commit 58ae297
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion source/framework/python/source/algorithm/uniform-1.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,26 @@ namespace lue::framework {
{
Rank const rank{2};

module.def("uniform", uniform<Element, rank>);
module.def(
"uniform",
uniform<Element, rank>,
R"(
Create new array, filled with uniformly distributed random values
:param array: "Clone array" to query for array shape and partition shape
to use
:param numpy.dtype dtype: Type of the array elements
:param min_value: Minimum potentially generated value
:param max_value: Maximum potentially generated value
:rtype: PartitionedArray specialization
The type of the array returned depends on the rank of the array and
the type of the array elements.
)",
"array"_a,
"dtype"_a,
"min_value"_a,
"max_value"_a);
}
};

Expand Down

0 comments on commit 58ae297

Please sign in to comment.