search

OpenMS / pyopenms-docs

pyOpenMS readthedocs documentation, additional utilities, addons, scripts, and examples.
https://pyopenms.readthedocs.io
Other
45 stars 55 forks source link

Prepare for OpenMS 3.2.0 release #440

Closed mr-c closed 2 months ago

mr-c commented 3 months ago

PR Type

documentation

Description

Changes walkthrough 📝

Relevant files
Documentation
conf.py
Update documentation version to 3.2.0                                       
docs/source/conf.py
  • Updated the version variable from 3.1.0 to 3.2.0.
  • Ensured the release variable reflects the new version.
    		•  +1/-1     
    switcher.json
    Add version 3.2.0 to documentation switcher                           
    docs/source/_static/switcher.json
  • Added new entry for version 3.2.0 with corresponding URL.
  • Reordered entries to include the new version.
    		•  +10/-0   

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    codiumai-pr-agent-pro[bot] commented 3 months ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Reviewer Guide 🔍

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Key issues to review

    None
    codiumai-pr-agent-pro[bot] commented 3 months ago

    PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

    PR Code Suggestions ✨

    CategorySuggestion                                                                                                                                    Score
    Best practice
    Remove the unnecessary Unicode string prefix for consistency ___ **It is recommended to use a consistent string format for version numbers. The 'u' prefix is
    unnecessary in Python 3 for Unicode strings. Removing it will clean up the code and
    maintain consistency.** [docs/source/conf.py [85]](https://github.com/OpenMS/pyopenms-docs/pull/440/files#diff-008dcb3426febd767787b1521f1fe33086313b927ea37eaab86df5fa88a51698R85-R85) ```diff -version = u'3.2.0' +version = '3.2.0' ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 8 Why: The 'u' prefix is unnecessary in Python 3 for Unicode strings. Removing it improves code readability and consistency without affecting functionality.
    		8
    Maintainability
    Sort version entries in descending order for better maintainability ___ **Ensure that the new version entries in the JSON file are sorted in descending order for
    better readability and maintenance. This helps in quickly identifying the most recent
    versions at the top of the file.** [docs/source/_static/switcher.json [7-15]](https://github.com/OpenMS/pyopenms-docs/pull/440/files#diff-85604925caaa67f516190fa5e9fd7e657574bd9d27d3e4c85f8e73c459d94e9aR7-R15) ```diff { "name": "3.2.0", "version": "3.2.0", "url": "https://pyopenms.readthedocs.io/en/release3.2.0/" -}, -{ - "name": "3.1.0", - "version": "3.1.0", - "url": "https://pyopenms.readthedocs.io/en/release3.1.0/" } ``` - [ ] **Apply this suggestion**
    Suggestion importance[1-10]: 7 Why: Sorting version entries in descending order improves readability and maintainability, making it easier to identify the most recent versions quickly.
    		7