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.

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

Update User_Guide for Python 3.13.0 compatibility #455

Merged
merged 1 commit into from
Mar 5, 2025

Conversation

ChandraDevs1
Copy link
Contributor

@ChandraDevs1 ChandraDevs1 commented Mar 4, 2025

Update user_guide for Python 3.13.0 compatibility

Description

This PR updates the user_guide documentation to reflect compatibility with Python 3.13.0.
Specifically, it modifies the installation.rst file to indicate support for Python versions 3.9 through 3.13.

Checklist

  • Updated installation.rst to include Python 3.13.0 in the list of supported versions.

Changes Made

  • In the docs/source/user_guide/installation.rst file, updated the section specifying supported Python versions to include 3.13.0.

Related Issue

Fixes #7874

Summary by CodeRabbit

  • Documentation
    • Updated the installation guide to expand compatibility with newer Python releases. The software now supports Python versions 3.9, 3.10, 3.11, 3.12, and 3.13, offering users improved flexibility. These changes ensure accurate, up-to-date information on supported Python environments and empower users by clarifying compatibility with the latest Python setups, enhancing overall user experience.

Copy link

coderabbitai bot commented Mar 4, 2025

Walkthrough

The documentation for pyOpenMS installation was updated to extend the supported Python versions. Previously, only Python 3.9, 3.10, and 3.11 were mentioned. The update now includes Python 3.12 and 3.13. No changes were made to any public or exported entities.

Changes

File Change Summary
docs/.../installation.rst Updated documentation to include Python 3.12 and 3.13 in the list of supported versions

Poem

In the garden of code, I hop and play,
Adding new versions in a clever array.
From Python 3.9 to 3.13 we cheer,
With every update, the path stays clear.
🥕 Happy coding from your bunny, so dear!


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7b0b40e and 66803af.

📒 Files selected for processing (1)
  • docs/source/user_guide/installation.rst (1 hunks)
🔇 Additional comments (1)
docs/source/user_guide/installation.rst (1)

34-34: Update Supported Python Versions

The updated supported versions now explicitly include Python 3.12 and 3.13, which correctly aligns with the PR objectives and issue #7874. The version list is clearly ordered, and the update is consistent with the rest of the documentation.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@ChandraDevs1
Copy link
Contributor Author

@cbielow Please review this PR and let me know if any modifications are needed. thanks

@jpfeuffer
Copy link
Contributor

Ideally this is not hardcoded in the docs.
Everyone should be able to check if a package exists on global pypi or our own pypi.
Potentially link to our build matrix. .github/workflows/python_versions.yaml

@ChandraDevs1
Copy link
Contributor Author

ChandraDevs1 commented Mar 4, 2025

alright,
Please see this .
https://github.com/OpenMS/OpenMS/issues/7874
thanks

@poshul
Copy link
Collaborator

poshul commented Mar 5, 2025

Since this is an improvement over what we have now (both hardcoded and wrong) I think it's reasonable to merge it and figure out a better solution over here OpenMS/OpenMS#7880

@poshul poshul merged commit 336edfc into OpenMS:master Mar 5, 2025
6 checks passed
@ChandraDevs1 ChandraDevs1 deleted the doc_update branch March 5, 2025 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants