engineerjoe440 / ElectricPy

Electrical Engineering Formulas in Python
https://electricpy.readthedocs.io/en/latest/
MIT License
86 stars 16 forks source link

Unify Module-Level Docstring Descriptions #64

Closed engineerjoe440 closed 2 years ago

engineerjoe440 commented 2 years ago

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