Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Transformation docstrings fixes #210

Merged
merged 4 commits into from
Jul 19, 2023
Merged

Conversation

Yoshanuikabundi
Copy link
Contributor

This fixes the warnings causing RTD to choke on OpenFreeEnergy/openfe#493 and also adds Transformation and NonTransformation 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 trailing ss after code spans and italicised regions and so on - so for example, I've changed `ChemicalSystem`s to `ChemicalSystem` objects

@codecov
Copy link

codecov bot commented Jul 19, 2023

Codecov Report

Patch coverage: 100.00% and no project coverage change.

Comparison is base (8d9fb2e) 99.09% compared to head (9413007) 99.09%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #210   +/-   ##
=======================================
  Coverage   99.09%   99.09%           
=======================================
  Files          36       36           
  Lines        1771     1771           
=======================================
  Hits         1755     1755           
  Misses         16       16           
Impacted Files Coverage Δ
gufe/transformations/transformation.py 100.00% <100.00%> (ø)

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

@richardjgowers richardjgowers merged commit e10293f into main Jul 19, 2023
7 checks passed
@richardjgowers richardjgowers deleted the transformation-docstrings-fixes branch July 19, 2023 08:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants