Skip to content

Commit

Permalink
Add sentence emphasizing that it is unlikely to have issues
Browse files Browse the repository at this point in the history
  • Loading branch information
ehuss committed Aug 19, 2024
1 parent 53ac97c commit 87dad99
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion src/rust-2024/rustdoc-doctests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 87dad99

Please sign in to comment.