Update tested versions in README#508
Conversation
MrCordeiro
left a comment
There was a problem hiding this comment.
I don't think this is required, unfortunately. Most minor versions are backwards compatible and we are quick to update this package when they're not.
|
I agree with you that wagtailmenus is generally compatible with minor versions and that the testing section of the README does not need to include them. However, my changes are not related to minor versions and do not change how they are handled in this section. I apologize for reopening this request, but the section is currently inaccurate. Right now, the README says that wagtailmenus is compatible with:
The section does not include Python 3.13. Because of the use of the greater than or equal signs that I previously mentioned, the section will automatically claim compatibility with future major versions of Django or Wagtail when they are released. I tried to make a minimal amount of changes to fix these problems and thought that they were straightforward and non-objectionable, but maybe I should have created an issue to discuss this first. There are a number of potential alternate solutions to fix the current issues, in order of my personal preference:
Please let me know if you would prefer one of these alternate solutions, and I will update this pull request to match it. If you don't think the current inaccuracy of the section is a problem, feel free to close this request again - I won't reopen it a second time. |
|
Changing the greater than signs to less than signs (since future major versions might have breaking changes that will require major changes) and adding Python 3.13 to the list of Python versions being tested sounds like the ideal solution to me. Plus, it keeps the testing matrix up-to-date, which we would appreciate! |
Replace greater-than-or-equal signs with less-than-or-equal signs in the version compatibility section of the README.
0b22c35 to
c90274f
Compare
|
I've added a new commit that only changes the GTE signs to LTE signs, since #509 updated the Python version compatibility. |
|
Hello @martey , |
|
Hi, Sorry for the delay in getting back to you.
I know that this seems simple and not that different from my existing changes, but I think that it actually makes the section harder to understand and less accurate. Neither Django nor Wagtail use true semantic versioning, so all new versions are "mostly backwards-compatible with the previous release" but not entirely backwards-compatible (see https://docs.djangoproject.com/en/6.0/internals/release-process/ and https://docs.wagtail.org/en/v7.1/releases/release_process.html). Because of this, I don't think we should assume that a version of wagtailmenus that is compatible with Django or Wagtail X.0 will be compatible with version X.1, much less a later release like X.2 or X.3. I should apologize because my previous comment wasn't completely clear - I used "less than signs" as a shorthand for LTE signs, and "major versions" as a shorthand for Django/Wagtail "feature release" versions. By "minor versions", I meant what Django and Wagtail call "patch releases", which should have full backwards compatibility. If you still would like me to change my PR to use LT signs (instead of LTE signs) and "X.0" versions (instead of feature release versions), let me know and I will update it. |
|
I don't understand why this was closed and locked. I don't think I have been disrespectful or disruptive. |
|
@martey , closed this by mistake. Apologies! Although I believe < are clearer, that's just my personal choice. |
Update the Wagtail, Django, and Python versions mentioned as being tested in the README based on the tox configuration.
This section previously used the greater-than-or-equal sign (
>=) when the less-than-or-equal sign (<=) was intended. Because these symbols are potentially confusing, they have been removed.