flask: be clearer that overwrites are only for testing

ref: #8 (reply in thread)
hynek · Aug 18, 2023 · 2597265 · 2597265
1 parent ba3d0b3
commit 2597265
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 3 deletions.
diff --git a/docs/integrations/flask.md b/docs/integrations/flask.md
@@ -203,11 +203,25 @@ def index():
 ```
 
 
-### Registering and Overwriting Services
+### Registering Services
 
 ```{eval-rst}
 .. autofunction:: register_factory
 .. autofunction:: register_value
+```
+
+
+### Testing
+
+:::{caution}
+This functions should not be used in production code.
+
+They always reset the container and run all cleanups after overwriting a service.
+
+See also {ref}`flask-testing`.
+:::
+
+```{eval-rst}
 .. autofunction:: overwrite_factory
 .. autofunction:: overwrite_value
 ```

diff --git a/src/svcs/flask.py b/src/svcs/flask.py
@@ -131,7 +131,6 @@ def overwrite_factory(
     .. seealso::
         - :meth:`svcs.Registry.register_factory()`
         - :meth:`svcs.Container.close()`
-        - :ref:`flask-testing`
     """
     container = svcs_from()
     container.registry.register_factory(
@@ -161,7 +160,6 @@ def overwrite_value(
     .. seealso::
         - :meth:`svcs.Registry.register_factory()`
         - :meth:`svcs.Container.close()`
-        - :ref:`flask-testing`
     """
     container = svcs_from()
     container.registry.register_value(