Introduce Upgrading doc page for tox4 #2805
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gaborbernat
requested changes
Jan 2, 2023
This adds a new page to the docs, Upgrading, meant to remove the documentation regarding backwards incompatible changes in tox4 from the FAQ into a dedicated page. The content of the page is primarily a lift-and-shift of the breaking changes section of the FAQ, and the FAQ page and Upgrading pages now cross-link to one another. New content is added to the Upgrading page in the form of a preamble for the doc.
|
That's a very fair ask. I've removed the additional doc and struck-through parts of the PR comment above. I'm happy to do a fresh PR if that's easier too. |
3 tasks
descope bot
added a commit
to descope/django-descope
that referenced
this pull request
Jan 18, 2023
This PR contains the following updates: | Package | Type | Update | Change | Pending | |---|---|---|---|---| | [tox](https://togithub.com/tox-dev/tox) ([changelog](https://tox.wiki/en/latest/changelog.html)) | dev | minor | `4.1.3` -> `4.2.0` | `4.3.4` (+12) | --- ### Release Notes <details> <summary>tox-dev/tox</summary> ### [`v4.2.0`](https://togithub.com/tox-dev/tox/releases/tag/4.2.0) [Compare Source](https://togithub.com/tox-dev/tox/compare/4.1.3...4.2.0) #### What's Changed - Introduce Upgrading doc page for tox4 by [@​sirosen](https://togithub.com/sirosen) in [tox-dev/tox#2805 - Document ambiguous usages in v3-to-v4 by [@​sirosen](https://togithub.com/sirosen) in [tox-dev/tox#2808 - Packaging inherits from pkgenv, deps and document tox 4 packaging changes by [@​gaborbernat](https://togithub.com/gaborbernat) in [tox-dev/tox#2813 **Full Changelog**: tox-dev/tox@4.1.3...4.2.0 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC45OS4yIiwidXBkYXRlZEluVmVyIjoiMzQuOTkuMiJ9--> Co-authored-by: descope[bot] <descope[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I wanted to contribute to some of the
help:wanteddocs issues, and picked #2728. However, it was not clear where this should go in the docs, and I think there are other issues related to tox4 changes which will have the same problem.I am therefore proposing a new page in the docs, an upgrading guide, which covers the backwards-incompatible changes.
(Inspired by various bits of prior art, including the sqlalchemy 2.0 migration doc.)
If this doesn't seem like a good addition/direction for the docs, please feel free to close, and I'll try to make contributions within the existing structure instead.
This adds a new page to the docs, Upgrading, meant to remove the documentation regarding backwards incompatible changes in tox4 from the FAQ into a dedicated page.
The content of the page is primarily a lift-and-shift of the breaking changes section of the FAQ, and the FAQ page and Upgrading pages now cross-link to one another.
New content is added to the Upgrading page in the form of
a section, "Legacy CLI entry point may result in ambiguous usages"The new section resolves #2728EDIT: I have removed part of this PR, indicated with strikethrough above.