Skip to content

Commit

Permalink
Fix documentation of proj_dist_fn parameter in clugen()
Browse files Browse the repository at this point in the history
  • Loading branch information
nunofachada committed Sep 2, 2023
1 parent c8486c7 commit 86aa0d5
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions pyclugen/main.py
Original file line number Diff line number Diff line change
Expand Up @@ -161,8 +161,8 @@ def clugen(
- `"norm"` (default): Distribute point projections along lines using a normal
distribution (μ=_line center_, σ=`llength/6`).
- `"unif"`: Distribute points uniformly along the line.
- User-defined function, which accepts two parameters, line length (`float`),
number of points (`int`) and an instance of
- User-defined function, which accepts three parameters, line length (`float`),
number of points (`int`), and an instance of
[`Generator`](https://numpy.org/doc/stable/reference/random/generator.html?highlight=generator#numpy.random.Generator),
and returns an array containing the distance of each point projection to
the center of the line. For example, the `"norm"` option roughly corresponds
Expand Down

0 comments on commit 86aa0d5

Please sign in to comment.