Skip to content

Commit 27ea010

Browse files
committed
Fix CI complaining about some poorly placed docs
1 parent cf4ac04 commit 27ea010

File tree

2 files changed

+13
-14
lines changed

2 files changed

+13
-14
lines changed

src/aspire/reconstruction/estimator.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,15 @@
1515

1616
class Estimator:
1717
def __init__(self, src, basis, batch_size=512, preconditioner="circulant"):
18+
"""
19+
An object representing a 2*L-by-2*L-by-2*L array containing the non-centered Fourier transform of the mean
20+
least-squares estimator kernel.
21+
Convolving a volume with this kernel is equal to projecting and backproject-ing that volume in each of the
22+
projection directions (with the appropriate amplitude multipliers and CTFs) and averaging over the whole
23+
dataset.
24+
Note that this is a non-centered Fourier transform, so the zero frequency is found at index 1.
25+
"""
26+
1827
self.src = src
1928
self.basis = basis
2029
self.dtype = self.src.dtype
@@ -36,15 +45,6 @@ def __init__(self, src, basis, batch_size=512, preconditioner="circulant"):
3645
f" Given src.L={src.L} != {basis.nres}"
3746
)
3847

39-
"""
40-
An object representing a 2*L-by-2*L-by-2*L array containing the non-centered Fourier transform of the mean
41-
least-squares estimator kernel.
42-
Convolving a volume with this kernel is equal to projecting and backproject-ing that volume in each of the
43-
projection directions (with the appropriate amplitude multipliers and CTFs) and averaging over the whole
44-
dataset.
45-
Note that this is a non-centered Fourier transform, so the zero frequency is found at index 1.
46-
"""
47-
4848
def __getattr__(self, name):
4949
"""Lazy attributes instantiated on first-access"""
5050

src/aspire/source/image.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -48,11 +48,10 @@ class ImageSource:
4848
objects, depending on unique CTF values found for _rlnDefocusU/_rlnDefocusV etc.
4949
"""
5050

51-
"""
52-
The metadata_fields dictionary below specifies default data types of certain key fields used in the codebase.
53-
The STAR file used to initialize subclasses of ImageSource may well contain other columns not found below; these
54-
additional columns are available when read, and they default to the pandas data type 'object'.
55-
"""
51+
# The metadata_fields dictionary below specifies default data types of certain key fields used in the codebase.
52+
# The STAR file used to initialize subclasses of ImageSource may well contain other columns not found below; these
53+
# additional columns are available when read, and they default to the pandas data type 'object'.
54+
5655
metadata_fields = {
5756
"_rlnVoltage": float,
5857
"_rlnDefocusU": float,

0 commit comments

Comments
 (0)