Update applies_to example for same lifecycle, multiple versions
#1945
Conversation
This file contains hidden or 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
theletterf
approved these changes
Sep 25, 2025
🔍 Preview links for changed docs |
|
@Mpdreamz Most interesting! Why do we get a preview only for one of the two files that have been changed? Is it because the change is in a snippet doc? |
vishaangelova
commented
Sep 25, 2025
vishaangelova
commented
Sep 25, 2025
Merged
6 tasks
colleenmcginnis
approved these changes
Sep 25, 2025
| ## Functionality is added to multiple patch versions [multiple-patch] | ||
|
|
||
| Sometimes, features and enhancements slip through into patch versions. In that case, the same functionality might be added for the first time to multiple patch versions at the same time. | ||
| Sometimes, features and enhancements slip through into patch versions, and the same functionality might be added for the first time to multiple patch versions at the same time. In that case, use two `applies_to` badges so that users can see clearly the versions in which the functionality is introduced. |
There was a problem hiding this comment.
Maybe add a note that the author should manually ensure that the applies_tos should be in order: starting with later versions, ending with earlier versions? (The auto-ordering doesn't work when there are multiple inline applies_tos.)
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.
With docs-builder 0.72.0, the rendering of one
applies_towith multiple values has changed. This requires changes in the guidelines for usingapplies_tofor functionality that becomes available in the same lifecycle in multiple versions.This PR updates the Functionality is added to multiple patch versions example scenario with a recommendation to use multiple
applies_totags in such cases.It also adds an example of such a use case in the Applies to style guide section.