search

SynBioDex / pySBOL

SWIG-Python wrappers implementing SBOL 2.2
Apache License 2.0
25 stars 8 forks source link

Typo in FunctionalComponent docstring #120

Closed rpgoldman closed 2 years ago

rpgoldman commented 4 years ago

The docstring for FunctionalComponent seems to have been garbled, to the point where I'm not sure I understand what it is trying to say:

class FunctionalComponent(ComponentInstance)
 |  The FunctionalComponent class is used to specify the functional usage of a
 |  ComponentDefinition inside a ModuleDefinition. The ModuleDefinition describes
 |  how the that describes how the FunctionalComponent interacts with others and
 |  summarizes their aggregate function.

My guess is that should be "The ModuleDefinition describes how the FunctionalComponent interacts with others and summarizes their aggregate function." Possibly also expand "their aggregate function" to "the aggregate function of the contained FunctionalComponents." -- the referent of "their" is not as clear as it could be.

jakebeal commented 2 years ago

Already fixed in referenced commit.