useblocks / sphinx-collections

Integrates different sources into one Sphinx project.
https://sphinx-collections.readthedocs.io/en/latest/
MIT License
18 stars 8 forks source link

Clarify docstring and mention subclassing of run method #13

Open jgarte opened 1 year ago

jgarte commented 1 year ago

Hi,

I updated the docstring for the run method.

Is my clarification correct?

That is, Driver's should be subclassed to create a more specific driver.

I also reworded the Driver class's info method for clarity.

Lastly, I rephrased some of the technical prose documentation for clarity.