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

gh-418: add variable names for Yields vars #428

Merged
merged 2 commits into from
Nov 15, 2024
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
10 changes: 9 additions & 1 deletion glass/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,12 @@ def iternorm(

Yields
------
The index, vector, and standard deviation for iterative sampling.
index
The index for iterative sampling.
vector
The vector for iterative sampling.
standard_deviation
The standard deviation for iterative sampling.

Raises
------
Expand Down Expand Up @@ -144,6 +149,7 @@ def cls2cov(

Yields
------
matrix
The covariance matrix for iterative sampling.

Raises
Expand Down Expand Up @@ -361,6 +367,7 @@ def generate_gaussian(

Yields
------
fields
The Gaussian random fields.

Raises
Expand Down Expand Up @@ -450,6 +457,7 @@ def generate_lognormal(

Yields
------
fields
The lognormal random fields.

"""
Expand Down
6 changes: 3 additions & 3 deletions glass/points.py
Original file line number Diff line number Diff line change
Expand Up @@ -342,11 +342,11 @@ def uniform_positions(

Yields
------
lon:
lon
Columns of longitudes for the sampled points.
lat:
lat
Columns of latitudes for the sampled points.
count:
count
The number of sampled points. For array inputs, an array of
counts with the same shape is returned.

Expand Down
1 change: 1 addition & 0 deletions glass/user.py
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,7 @@ def write_catalog(

Yields
------
writer
The writer object.

"""
Expand Down