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

Jump to bottom

Remove pickle from docstring for loading files #238

Merged
merged 1 commit into from
Apr 25, 2024
Merged

Remove pickle from docstring for loading files #238

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 2 additions & 2 deletions ms2query/utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,14 @@ def load_matchms_spectrum_objects_from_file(file_name
"""Loads spectra from your spectrum file into memory as matchms Spectrum object

The following file extensions can be loaded in with this function:
"mzML", "json", "mgf", "msp", "mzxml", "usi" and "pickle".
"mzML", "json", "mgf", "msp", "mzxml" and "usi".
A pickled file is expected to directly contain a list of matchms spectrum objects.

Args:
-----
file_name:
Path to file containing spectra, with file extension "mzML", "json", "mgf", "msp",
"mzxml", "usi" or "pickle"
"mzxml" or "usi".
"""
assert os.path.exists(file_name), f"The specified file: {file_name} does not exists"

Expand Down
Loading