PyOpenSource / CompleteME

Automated problem generation for the mechanical engineering field
0 stars 1 forks source link

V00 Documentation Update #3

Open jbm950 opened 6 years ago

jbm950 commented 6 years ago

Add docstrings and comments to the Fourier's Law function and the Fourier's Law Problem Generator

A good example of the docstring format being looked for is in the sympy body file from the sympy/physics/mechanics package. This format is roughly the numpy documentation standard

The comments can be more generic to assist those who will alter or maintain the code in the future.