Closed Yoshanuikabundi closed 1 year ago
Patch coverage: 100.00%
and no project coverage change.
Comparison is base (
ddd4ca4
) 99.12% compared to head (6cb6c22
) 99.12%.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
I think this is ready to go!
@dwhswenson I completely agree that these docstrings are unclear, but can we leave it for another PR? It'll need input from someone who knows what is going on and this PR is currently holding up https://github.com/OpenFreeEnergy/openfe/pull/527. I've raised an #223 as a reminder.
Yep... with #223 to remind, I think this is good. Sorry if this slows you down at all. I'm trying to take advantage of a new set of eyes on the docs as a chance to improve aspects that are unclear when we look at them with our own fresh eyes.
This PR moves more docstrings out of
attribute
sections of docstrings and onto the corresponding object itself. This helps comprehensive API documentation in OpenFE. Required by https://github.com/OpenFreeEnergy/openfe/pull/527