Merge pull request #285 from wilhelm-lab/patch/fix_documentation

Patch/fix documentation
wilhelm-lab · Oct 11, 2024 · c5af565 · c5af565
2 parents ddc659f + 40cba07
commit c5af565
Show file tree

Hide file tree

Showing 9 changed files with 19 additions and 189 deletions.
diff --git a/.cookietemple.yml b/.cookietemple.yml
@@ -15,5 +15,5 @@ full_name: Victor Giurcoiu
 email: [email protected]
 project_name: oktoberfest
 project_short_description: Public repo oktoberfest
-version: 0.8.1
+version: 0.8.2
 license: MIT
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -1,5 +1,5 @@
-name-template: "0.8.1 🌈" # <<COOKIETEMPLE_FORCE_BUMP>>
-tag-template: 0.8.1 # <<COOKIETEMPLE_FORCE_BUMP>>
+name-template: "0.8.2 🌈" # <<COOKIETEMPLE_FORCE_BUMP>>
+tag-template: 0.8.2 # <<COOKIETEMPLE_FORCE_BUMP>>
 exclude-labels:
     - "skip-changelog"
 

diff --git a/cookietemple.cfg b/cookietemple.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 0.8.1
+current_version = 0.8.2
 
 [bumpversion_files_whitelisted]
 init_file = oktoberfest/__init__.py

diff --git a/docs/_key_contributors.rst b/docs/_key_contributors.rst
@@ -6,7 +6,7 @@
    * `Wassim Gabriel <https://github.com/WassimG>`_
    * `Victor-George Giurcoiu <https://github.com/victorgiurcoiu>`_
    * `Firas Hamood <https://github.com/fhamood>`_
-   * `Cecilia Jensen`
+   *  Cecilia Jensen
    * `Mostafa Kalhor <https://github.com/mostafakalhor>`_
    * `Ludwig Lautenbacher <https://github.com/LLautenbacher>`_
    * `Julian Mueller <https://github.com/jmueller95>`_

diff --git a/docs/conf.py b/docs/conf.py
@@ -55,9 +55,9 @@
 # the built documents.
 #
 # The short X.Y version.
-version = "0.8.1"
+version = "0.8.2"
 # The full version, including alpha/beta/rc tags.
-release = "0.8.1"
+release = "0.8.2"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/docs/config.rst b/docs/config.rst
@@ -164,7 +164,7 @@ Applicable to PTM pipeline
    +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
    |     possible_sites         | List of Possible sites where the PTM can happen. e.g (['R','N','Q'] for citrullination/deamidation)                                                                |
    +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-   |     neutral_loss           | Flag to annotate neutral loss peaks or not.                                                                                                                        |
+   |     neutral_loss           | Flag to annotate neutral loss peaks and use it as a feaure in percolator.                                                                                          |
    +----------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
 Applicable to local intensity prediction

diff --git a/oktoberfest/__init__.py b/oktoberfest/__init__.py
@@ -5,7 +5,7 @@
 __author__ = """The Oktoberfest development team (Wilhelmlab at Technical University of Munich)"""
 __copyright__ = f"Copyright {datetime.now():%Y}, Wilhelmlab at Technical University of Munich"
 __license__ = "MIT"
-__version__ = "0.8.1"
+__version__ = "0.8.2"
 
 import logging.handlers
 import sys

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oktoberfest"
-version = "0.8.1"  # <<COOKIETEMPLE_FORCE_BUMP>>
+version = "0.8.2"  # <<COOKIETEMPLE_FORCE_BUMP>>
 description = "Public repo oktoberfest"
 authors = ["Wilhelmlab at Technical University of Munich"]
 license = "MIT"

diff --git a/tutorials/Prosit_cit_tutorial.ipynb b/tutorials/Prosit_cit_tutorial.ipynb