Skip to content

add clarity in requirements section for version support #9806

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

add clarity in requirements section for version support #9806

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Some reasons you might want to use REST framework:
* Python 3.10+
* Django 4.2, 5.0, 5.1, 5.2

We **highly recommend** and only officially support the latest patch release of
We **highly recommend** and only officially support the latest patch release (for example, 3.12.x or 5.2.x) of
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think the existing sentence is clear enough

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For experience user It might be clear enough, However for new user (beginners) it might be unclear.
But I agree with you , it is clear enough. I can revert it if you want

each Python and Django series.

# Installation
Expand Down
7 changes: 5 additions & 2 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,11 @@ REST framework requires the following:
* Django (4.2, 5.0, 5.1, 5.2)
* Python (3.10, 3.11, 3.12, 3.13, 3.14)

We **highly recommend** and only officially support the latest patch release of
each Python and Django series.
**Note:** Python **3.14** requires Django **5.2 or newer**.
Copy link
Collaborator

Choose a reason for hiding this comment

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

That's not a requirement from DRF, it's a requirement from Django

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are right. it is not a DRF constraint.
But developer checking DRF requirements will likely encounter this constraint immediately when choosing their Django version.
May be I can reword to something like:
When setting up your environment, be aware that Python 3.14 requires Django 5.2 or newer.

For more details, see [Django version support](https://docs.djangoproject.com/en/5.2/faq/install/#what-python-version-can-i-use-with-django).


We **highly recommend** and only officially support the latest patch release (for example, 3.12.x or 5.2.x) of each supported Python and Django series.

The following packages are optional:

Expand Down