Doc push

[richardjgowers]

refresh of many objects docstrings

[pep8speaks]

Hello @richardjgowers! Thanks for opening this PR. We checked the lines you've touched for PEP 8 issues, and found:

• In the file gufe/chemicalsystem.py:

Line 24:1: W293 blank line contains whitespace

• In the file gufe/components/proteincomponent.py:

Line 60:80: E501 line too long (82 > 79 characters)
Line 63:80: E501 line too long (85 > 79 characters)

• In the file gufe/components/smallmoleculecomponent.py:

Line 84:80: E501 line too long (85 > 79 characters)
Line 86:80: E501 line too long (82 > 79 characters)
Line 87:80: E501 line too long (92 > 79 characters)
Line 92:80: E501 line too long (82 > 79 characters)
Line 93:80: E501 line too long (87 > 79 characters)

• In the file gufe/mapping/componentmapping.py:

Line 10:80: E501 line too long (84 > 79 characters)

• In the file gufe/protocols/protocol.py:

Line 68:80: E501 line too long (86 > 79 characters)
Line 91:80: E501 line too long (80 > 79 characters)
Line 186:71: W605 invalid escape sequence '\s'
Line 188:80: E501 line too long (81 > 79 characters)

• In the file gufe/transformations/transformation.py:

Line 30:80: E501 line too long (82 > 79 characters)
Line 33:80: E501 line too long (82 > 79 characters)
Line 42:80: E501 line too long (80 > 79 characters)
Line 45:75: W605 invalid escape sequence '\s'
Line 80:80: E501 line too long (80 > 79 characters)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (c998c5e) 98.93% compared to head (8e5008b) 98.93%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #289      +/-   ##
==========================================
- Coverage   98.93%   98.93%   -0.01%     
==========================================
  Files          36       36              
  Lines        1979     1976       -3     
==========================================
- Hits         1958     1955       -3     
  Misses         21       21              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.