From 194a51c3c25a59cf8e3fe52debef1e6d29812544 Mon Sep 17 00:00:00 2001 From: Dilum Aluthge Date: Mon, 6 Oct 2025 20:43:48 -0400 Subject: [PATCH] Docs: Recommend that packages using Base internals specify a tilde or equals compat entry for Julia --- doc/src/manual/faq.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/doc/src/manual/faq.md b/doc/src/manual/faq.md index 5515d65773127..d64ade63d9be0 100644 --- a/doc/src/manual/faq.md +++ b/doc/src/manual/faq.md @@ -54,7 +54,9 @@ to open an [issue](https://github.com/JuliaLang/julia/issues) or [pull request](https://github.com/JuliaLang/julia/pulls) to start a discussion for turning it into a public API. However, we do not discourage the attempt to create packages that expose stable public interfaces while relying on non-public implementation details of Julia and -buffering the differences across different Julia versions. +buffering the differences across different Julia versions. Such packages should use tilde +(`julia = "~1.10"`) or equals (`julia = "=1.10.5"`) specifiers in their Julia `[compat]` entries, +instead of the default (caret) specifier. ### The documentation is not accurate enough. Can I rely on the existing behavior?