Clarify that ProteinComponent wraps a PDB

OpenFreeEnergy · Aug 29, 2023 · 2ff5557 · 2ff5557
1 parent 1cb87ad
commit 2ff5557
Showing 1 changed file with 6 additions and 5 deletions.
diff --git a/gufe/components/proteincomponent.py b/gufe/components/proteincomponent.py
@@ -57,12 +57,13 @@
 
 class ProteinComponent(ExplicitMoleculeComponent):
     """
-    :class:`Component` representing a protein.
+    ``Component`` representing the contents of a PDB file, such as a protein.
 
-    In comparison to a SmallMoleculeComponent, this representation additionally contains information
-    relating to the residue and chain information.  This is achievable by having the MonomerInfo attributes
-    present on each atom of the input RDKit molecule, which is done when reading from either PDB or `.mae`
-    file inputs.
+    In comparison to a SmallMoleculeComponent, this representation additionally
+    contains information relating to the residue and chain information.  This
+    is achievable by having the ``MonomerInfo`` attributes present on each atom
+    of the input RDKit molecule, which is done when reading from either PDB or
+    ``.mae`` file inputs.
 
     Note
     ----