Skip to content

Docs Fix - Aligned to Python 3.13 version#97

Merged
xInsanityInRed merged 5 commits into
mainfrom
docs/align-to-python-3.13
Jun 15, 2026
Merged

Docs Fix - Aligned to Python 3.13 version#97
xInsanityInRed merged 5 commits into
mainfrom
docs/align-to-python-3.13

Conversation

@xInsanityInRed

@xInsanityInRed xInsanityInRed commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator

name: Pull Request
about: Submit your completed changes for review
title: "[PR] Fixed all docs and builders/CI to align to Python 3.13"
labels: ["student-submission"]

Description

Refactored the Python version requirement back to 3.13 in all documents/files.
Additionally, I removed the "result-pattern" package is it was only supported by Python 3.14 & had no dependencies.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Checked all files for references to Python & Python versions.
Checked documentation for all existing packages in requirements.txt to ensure they support Python 3.13

Checklist:

  • I have followed the coding style guidelines of this project
  • I have reviewed my own code
  • I have commented hard-to-understand areas of my code
  • I have added docstrings to all public functions/methods
  • I have used descriptive variable names to make by code easier to understand
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Related Issue(s)

Closes #46

@xInsanityInRed xInsanityInRed added this to the v0.0.1 milestone Jun 11, 2026
@xInsanityInRed xInsanityInRed self-assigned this Jun 11, 2026
@xInsanityInRed xInsanityInRed added documentation Improvements or additions to documentation good first issue Good for newcomers v0.0.1 Issue is to be complete before version v0.0.1 is committed DX Issue would improve the developer experience labels Jun 11, 2026
@xInsanityInRed

xInsanityInRed commented Jun 11, 2026

Copy link
Copy Markdown
Collaborator Author

Hi @Robbo-lab

The Python version required for the package "result-pattern" is 3.14, is there a replacement for this package or should this be a separate issue? Reference: result-pattern documentation

Regards,
Gabrielle

@Robbo-lab

Robbo-lab commented Jun 11, 2026 via email

Copy link
Copy Markdown
Owner

@xInsanityInRed

Copy link
Copy Markdown
Collaborator Author

Hi @Robbo-lab

Yep
I'm unsure if the result-pattern package can be used by Python version 3.13 (or earlier) since 2 GitHub Actions tests failed when reaching this line + I haven't made any code changes outside of setting the Python version.

@AlexSchmidtNmTafe AlexSchmidtNmTafe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes seem good, please fix so it passes the test/s and linting in the checks.

@xInsanityInRed

Copy link
Copy Markdown
Collaborator Author

Hi @AlexSchmidtNmTafe
The "result-pattern" package appears to only work with Python versions 3.14+ (reference: result-pattern pypi doc), which might explain why the linting process fails when installing it.

Is there any way this can be changed to allow for use with Python 3.13, or another package that may replace this? I'm happy to look into the latter if it's okay

@Robbo-lab

Robbo-lab commented Jun 13, 2026

Copy link
Copy Markdown
Owner

@xInsanityInRed this package is only designed for 3.14 but we are not using anywhere, in your branch can you remove if form the dependecnies reinstall and run tests locally to see if the application fail, if it does let me know. It may be a dependency of another library. https://pypi.org/project/result-pattern/0.2.2/

@xInsanityInRed

Copy link
Copy Markdown
Collaborator Author

@xInsanityInRed this package is only designed for 3.14 but we are not using anywhere, in your branch can you remove if form the dependecnies reinstall and run tests locally to see if the application fail, if it does let me know. It may be a dependency of another library. https://pypi.org/project/result-pattern/0.2.2/

Hi @Robbo-lab
Removing the package has solved the linting issue and none of the tests failed locally :)

@Robbo-lab

Robbo-lab commented Jun 13, 2026 via email

Copy link
Copy Markdown
Owner

@xInsanityInRed xInsanityInRed left a comment

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be ready to merge, please let me know if I have missed anything

@AlexSchmidtNmTafe AlexSchmidtNmTafe left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

THanks for amending.

@xInsanityInRed xInsanityInRed merged commit 8b99d63 into main Jun 15, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation DX Issue would improve the developer experience good first issue Good for newcomers v0.0.1 Issue is to be complete before version v0.0.1 is committed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Docs] Align supported Python version to 3.13 across docs and CI

3 participants