ElectricPy icon indicating copy to clipboard operation
ElectricPy copied to clipboard

Unify Module-Level Docstring Descriptions

Open engineerjoe440 opened this issue 3 years ago • 0 comments

Each of the various modules have a "module-level" docstring that should reflect a brief synopsis of what the module is intended for. These should really be unified so that they're more consistent and helpful. Here's some examples of how they appear inconsistent in documentation, with what looks "good" and what looks "less good."

image

engineerjoe440 avatar May 06 '22 19:05 engineerjoe440