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.

Sign up for GitHub

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 docstrings #459

Merged
merged 2 commits into from
Mar 8, 2018
Merged

Fix docstrings #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c492f13
fix docstring
eelregit Feb 1, 2018
0d47b6a
Add comments in docstring
eelregit Mar 7, 2018
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 nbodykit/algorithms/convpower.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ def get_real_Ylm(l, m):
l : int
the degree of the harmonic
m : int
the order of the harmonic; abs(m) < l
the order of the harmonic; abs(m) <= l

Returns
-------
Expand Down
7 changes: 6 additions & 1 deletion nbodykit/meshtools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,12 @@ def mu(self, los):
def nonsingular(self):
"""
The indices on the slab of the positive frequencies
along the dimension specified by `symmetry_axis`
along the dimension specified by `symmetry_axis`.

This takes advantage of the fact that :class:`pmesh.pm.ComplexField`
shifts the Nyquist frequencies to the negative halves.
Therefore this ensures that the zero and Nyquist planes perpendicular
to the symmetry axis have weight 1, whereas other modes have weight 2.

Returns
-------
Expand Down