MTgeophysics / mtpy

Python toolbox for standard Magnetotelluric (MT) data analysis
GNU General Public License v3.0
147 stars 66 forks source link

cross check the docstring with the auto-generated doc in readthedocs #67

Open zhang01GA opened 6 years ago

zhang01GA commented 6 years ago

Expected Behavior

source code docstring should be correctly extracted in the online docs publising https://mtpy2.readthedocs.io/en/develop

Current Behavior

there are some inconsistency, which can only be noticed after careful cross-check.

Possible Solution

go through the scripts one-by-one

Steps to Reproduce (for bugs)

1. 2. 3. 4.

# Paste your code here
#
#

Context

Your Environment

Installed Python Packages: use pip freeze or conda list [-n ENVIRONMENT_NAME] to list all the installed libraries.