From fc2d48fa30ffa3766cb16108adb6f37e575244f6 Mon Sep 17 00:00:00 2001 From: Michael Osthege Date: Sun, 13 Oct 2024 15:47:23 +0200 Subject: [PATCH] Fix formatting of license and module docstrings --- peak_performance/models.py | 27 ++++++++++++++------------- peak_performance/pipeline.py | 27 ++++++++++++++------------- peak_performance/plots.py | 27 ++++++++++++++------------- 3 files changed, 42 insertions(+), 39 deletions(-) diff --git a/peak_performance/models.py b/peak_performance/models.py index c2ff2af..91a3a20 100644 --- a/peak_performance/models.py +++ b/peak_performance/models.py @@ -1,19 +1,20 @@ -""" -PeakPerformance -Copyright (C) 2023 Forschungszentrum Jülich GmbH +# PeakPerformance +# Copyright (C) 2023 Forschungszentrum Jülich GmbH -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero General Public License as published -by the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published +# by the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +""" +This module contains functions for creating various kinds of peak models and to make initial guesses for their parameters. """ from enum import Enum diff --git a/peak_performance/pipeline.py b/peak_performance/pipeline.py index 7224602..d13b021 100644 --- a/peak_performance/pipeline.py +++ b/peak_performance/pipeline.py @@ -1,19 +1,20 @@ -""" -PeakPerformance -Copyright (C) 2023 Forschungszentrum Jülich GmbH +# PeakPerformance +# Copyright (C) 2023 Forschungszentrum Jülich GmbH -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero General Public License as published -by the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published +# by the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +""" +Defines steps for a pipeline to process LC-MS-MS data. """ import importlib diff --git a/peak_performance/plots.py b/peak_performance/plots.py index ad69308..b5928ca 100644 --- a/peak_performance/plots.py +++ b/peak_performance/plots.py @@ -1,19 +1,20 @@ -""" -PeakPerformance -Copyright (C) 2023 Forschungszentrum Jülich GmbH +# PeakPerformance +# Copyright (C) 2023 Forschungszentrum Jülich GmbH -This program is free software: you can redistribute it and/or modify -it under the terms of the GNU Affero General Public License as published -by the Free Software Foundation, either version 3 of the License, or -(at your option) any later version. +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published +# by the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. -This program is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -GNU Affero General Public License for more details. +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. -You should have received a copy of the GNU Affero General Public License -along with this program. If not, see . +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . +""" +Functions for preparing diagnostic and QC plots. """ import os