Document that one additional plugin per app should implement getAxial…

…ExpansionChanger hook
terrapower · Sep 17, 2024 · 9dbbca2 · 9dbbca2
1 parent 0416cb7
commit 9dbbca2
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/armi/plugins.py b/armi/plugins.py
@@ -692,6 +692,10 @@ def getAxialExpansionChanger() -> type["AxialExpansionChanger"]:
  This hook **should not** provide an instance of the class. The construction
  of the changer will be handled by applications and plugins that need it.
 
+ This hook should only be provided by one additional plugin in your application. Otherwise
+ the `order of hook execution <https://pluggy.readthedocs.io/en/stable/index.html#call-time-order>`_
+ may not provide the behavior you expect.
+
  Examples
  --------
  >>> class MyPlugin(ArmiPlugin):