search

mrahnis / surficial

Python library and CLI tools to support stream long-profile analysis and plotting.
BSD 3-Clause "New" or "Revised" License
1 stars 0 forks source link

Docsting improvements for DataFrames #41

Open mrahnis opened 2 years ago

mrahnis commented 2 years ago

Try formatting docstrings to better describe DataFrames. This StackOverflow comment gives some advice: how-do-you-specify-a-pandas-dataframe-schema-structure-in-a-docstring

mrahnis commented 2 years ago

Example of reStructuredText tables is here: https://stackoverflow.com/questions/57225904/type-annotating-pandas-dataframes#57227414