Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This fixes the warnings causing RTD to choke on OpenFreeEnergy/openfe#493 and also adds
Transformation
andNonTransformation
to the GUFE API reference (for good measure).Previously, several properties in both classes had docstrings AND an
Attributes
entry in the class docstring. This meant that they were documented twice, which Sphinx gets grumpy about. The documentation was also not identical, so readers noticing one might have missed information present only in the other. I've consolidated the documentation and type hints into the property docstrings and annotations. I've also fixed some errors arising because ReST is very picky about trailings
s after code spans and italicised regions and so on - so for example, I've changed`ChemicalSystem`s
to`ChemicalSystem` objects