Skip to content

Commit 0841155

Browse files
Some updates to make this code consistent
1 parent 02bcd46 commit 0841155

File tree

1 file changed

+10
-11
lines changed

1 file changed

+10
-11
lines changed

mxcubecore/HardwareObjects/abstract/AbstractXRFSpectrum.py

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -84,20 +84,19 @@ def start_spectrum(
8484
"""Start the procedure. Called by the queue_model.
8585
8686
Args:
87-
integration_time: Inregration time [s].
88-
data_dir: Directory to save the data (full path).
89-
archive_dir: Directory to save the archive data (full path).
90-
prefix: File prefix
91-
session_id: Session ID number (from ISpyB)
92-
blsample_id: Sample ID number (from ISpyB)
93-
cpos: The centred position motors and their values.
87+
integration_time (float): Inregration time [s].
88+
data_dir (str): Directory to save the data (full path).
89+
archive_dir (str): Directory to save the archive data (full path).
90+
prefix (str): File prefix.
91+
session_id (int): Session ID number (from ISpyB).
92+
blsample_id (int): Sample ID number (from ISpyB).
93+
cpos (dict): The centred position motors and their values.
9494
"""
9595
self.cpos = cpos
9696
self.spectrum_info_dict = {"sessionId": session_id, "blSampleId": blsample_id}
9797
integration_time = integration_time or self.default_integration_time
9898
self.spectrum_info_dict["exposureTime"] = integration_time
9999
self.spectrum_info_dict["filename"] = ""
100-
101100
# Create the data and the archive directory (if needed) and files
102101
if data_dir:
103102
if not self.create_directory(data_dir):
@@ -135,8 +134,8 @@ def execute_spectrum(
135134
"""Do the acquisition.
136135
137136
Args:
138-
integration_time: MCA integration time [s].
139-
filename: Data file (full path).
137+
integration_time (float): MCA integration time [s].
138+
filename (str): Data file (full path).
140139
Raises:
141140
RuntimeError: Cannot acquire data.
142141
"""
@@ -166,7 +165,7 @@ def _execute_spectrum(
166165
def create_directory(self, directory: str) -> bool:
167166
"""Create a directory, if needed.
168167
Args:
169-
directory: Directory to save the data (full path).
168+
directory (str): Directory to save the data (full path).
170169
Returns:
171170
``True`` if directory created or already exists, ``False`` if error.
172171
"""

0 commit comments

Comments
 (0)