Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix references for types in docstrings. #111

Merged
merged 1 commit into from
Apr 26, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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