From 87dad99b14ed634d94fcdd2b742529a6d5bd4e37 Mon Sep 17 00:00:00 2001 From: Eric Huss Date: Mon, 19 Aug 2024 11:07:21 -0700 Subject: [PATCH] Add sentence emphasizing that it is unlikely to have issues --- src/rust-2024/rustdoc-doctests.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/rust-2024/rustdoc-doctests.md b/src/rust-2024/rustdoc-doctests.md index 3e44330..fb315fc 100644 --- a/src/rust-2024/rustdoc-doctests.md +++ b/src/rust-2024/rustdoc-doctests.md @@ -73,4 +73,4 @@ This example is sensitive to the code structure of how the example is compiled. ## Migration -There is no automatic migration to determine which doctests need to be annotated with the `standalone` tag. You will need to update your crate to the 2024 Edition and then run your documentation tests and see if any of them fail. If they do fail, you will need to analyze whether the test can be rewritten to be compatible with the combined approach, or add the `standalone` tag to retain the previous behavior. +There is no automatic migration to determine which doctests need to be annotated with the `standalone` tag. It's very unlikely that doctests will not work correctly when merged. The only way to know is to update your crate to the 2024 Edition and then run your documentation tests and see if any of them fail. If they do fail, you will need to analyze whether the test can be rewritten to be compatible with the combined approach, or add the `standalone` tag to retain the previous behavior.