Skip to content

Commit

Permalink
Merge pull request #111 from stefmolin/doc-refs
Browse files Browse the repository at this point in the history
Fix references for types in docstrings.
  • Loading branch information
stefmolin authored Apr 26, 2023
2 parents 56f5886 + 899ae9d commit 46eed1b
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
2 changes: 1 addition & 1 deletion src/data_morph/data/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ class Dataset:
See Also
--------
DataLoader
:class:`.DataLoader`
Utility for creating :class:`Dataset` objects from CSV files.
"""

Expand Down
6 changes: 3 additions & 3 deletions src/data_morph/morpher.py
Original file line number Diff line number Diff line change
Expand Up @@ -354,15 +354,15 @@ def morph(
The maximum temperature for simulated annealing (starting temperature).
min_temp : numbers.Number
The minimum temperature for simulated annealing (ending temperature).
min_shake : Number
min_shake : numbers.Number
The standard deviation of random movement applied in each direction,
sampled from a normal distribution with a mean of zero. Value will start
at ``max_shake`` and move toward ``min_shake``.
max_shake : Number
max_shake : numbers.Number
The standard deviation of random movement applied in each direction,
sampled from a normal distribution with a mean of zero. Value will start
at ``max_shake`` and move toward ``min_shake``.
allowed_dist : Number
allowed_dist : numbers.Number
The farthest apart the perturbed points can be from the target shape.
ramp_in : bool, default ``False``
Whether to more slowly transition in the beginning.
Expand Down
2 changes: 1 addition & 1 deletion src/data_morph/shapes/bases/point_collection.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ class PointCollection(Shape):

def __init__(self, *points: Iterable[Number]) -> None:
self.points = np.array(points)
"""numpy.array: An array of (x, y) values
"""numpy.ndarray: An array of (x, y) values
representing an arrangement of points."""

self._alpha = 1
Expand Down

0 comments on commit 46eed1b

Please sign in to comment.