Add deprecated directive for add_variants_async

Signed-off-by: Jean-Christophe Morin <38703886+JeanChristopheMorinPerso@users.noreply.github.com>
AcademySoftwareFoundation · Mar 8, 2024 · b0309eb · b0309eb
1 parent 2251de8
commit b0309eb
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/rez/package_cache.py b/src/rez/package_cache.py
@@ -372,7 +372,8 @@ def add_variants_async(self, variants):
         This method is called when a context is created or sourced. Variants
         are then added to the cache in a separate process.
 
-        This method is left for backwards compatibility.
+        .. deprecated:: 3.1.0
+           Use :method:`add_variants` instead.
         """
         return self.add_variants(variants, package_cache_async=True)