diff --git a/src/stk/molecular/topology_graphs/cof/periodic_hexagonal.py b/src/stk/molecular/topology_graphs/cof/periodic_hexagonal.py index 41c7fefc1..6b7f92dad 100644 --- a/src/stk/molecular/topology_graphs/cof/periodic_hexagonal.py +++ b/src/stk/molecular/topology_graphs/cof/periodic_hexagonal.py @@ -30,8 +30,8 @@ class PeriodicHexagonal(Cof): | 6-functional groups: 0 to 3 | 2-functional groups: 4 to 15 - Note that only :class:`.PeriodicCollapser` optimizes the - :class:`.PeriodicInfo`. + Note that optimizers may not optimize the :class:`.PeriodicInfo`. + The documentation of the optimizer will state if it does. See :class:`.Cof` for more details and examples. diff --git a/src/stk/molecular/topology_graphs/cof/periodic_honeycomb.py b/src/stk/molecular/topology_graphs/cof/periodic_honeycomb.py index 9486465a2..d93e44e9e 100644 --- a/src/stk/molecular/topology_graphs/cof/periodic_honeycomb.py +++ b/src/stk/molecular/topology_graphs/cof/periodic_honeycomb.py @@ -30,8 +30,8 @@ class PeriodicHoneycomb(Cof): | 3-functional groups: 0 to 1 | 2-functional groups: 2 to 4 - Note that only :class:`.PeriodicCollapser` optimizes the - :class:`.PeriodicInfo`. + Note that optimizers may not optimize the :class:`.PeriodicInfo`. + The documentation of the optimizer will state if it does. See :class:`.Cof` for more details and examples. diff --git a/src/stk/molecular/topology_graphs/cof/periodic_kagome.py b/src/stk/molecular/topology_graphs/cof/periodic_kagome.py index aa22fb3d7..abab824dc 100644 --- a/src/stk/molecular/topology_graphs/cof/periodic_kagome.py +++ b/src/stk/molecular/topology_graphs/cof/periodic_kagome.py @@ -30,8 +30,8 @@ class PeriodicKagome(Cof): | 4-functional groups: 0 to 2 | 2-functional groups: 3 to 8 - Note that only :class:`.PeriodicCollapser` optimizes the - :class:`.PeriodicInfo`. + Note that optimizers may not optimize the :class:`.PeriodicInfo`. + The documentation of the optimizer will state if it does. See :class:`.Cof` for more details and examples. diff --git a/src/stk/molecular/topology_graphs/cof/periodic_linkerless_honeycomb.py b/src/stk/molecular/topology_graphs/cof/periodic_linkerless_honeycomb.py index bc7ee85c0..d8a2c9873 100644 --- a/src/stk/molecular/topology_graphs/cof/periodic_linkerless_honeycomb.py +++ b/src/stk/molecular/topology_graphs/cof/periodic_linkerless_honeycomb.py @@ -29,8 +29,8 @@ class PeriodicLinkerlessHoneycomb(Cof): | 3-functional groups: 0 to 1 - Note that only :class:`.PeriodicCollapser` optimizes the - :class:`.PeriodicInfo`. + Note that optimizers may not optimize the :class:`.PeriodicInfo`. + The documentation of the optimizer will state if it does. See :class:`.Cof` for more details and examples. diff --git a/src/stk/molecular/topology_graphs/cof/periodic_square.py b/src/stk/molecular/topology_graphs/cof/periodic_square.py index 07d51fa6c..a40039fa7 100644 --- a/src/stk/molecular/topology_graphs/cof/periodic_square.py +++ b/src/stk/molecular/topology_graphs/cof/periodic_square.py @@ -9,11 +9,7 @@ from ...reactions import GenericReactionFactory from .cof import Cof from .vertices import _LinearCofVertex, _NonLinearCofVertex -from ..topology_graph import ( - Edge, - NullOptimizer, - PeriodicConstructionResult, -) +from ..topology_graph import Edge, NullOptimizer from ...periodic_info import PeriodicInfo @@ -33,8 +29,8 @@ class PeriodicSquare(Cof): | 4-functional groups: 0 | 2-functional groups: 1 to 2 - Note that only :class:`.PeriodicCollapser` optimizes the - :class:`.PeriodicInfo`. + Note that optimizers may not optimize the :class:`.PeriodicInfo`. + The documentation of the optimizer will state if it does. See :class:`.Cof` for more details and examples. diff --git a/src/stk/molecular/topology_graphs/topology_graph/optimizers/periodic_collapser.py b/src/stk/molecular/topology_graphs/topology_graph/optimizers/periodic_collapser.py index 986bf0db4..d09379ab8 100644 --- a/src/stk/molecular/topology_graphs/topology_graph/optimizers/periodic_collapser.py +++ b/src/stk/molecular/topology_graphs/topology_graph/optimizers/periodic_collapser.py @@ -14,6 +14,8 @@ class PeriodicCollapser(Optimizer): """ Performs rigid-body collapse of molecules [1]_. + This :class:`.Optimizer` will also update the `.PeriodicInfo`. + Examples -------- *Structure Optimization*