nbdev adding description for api files

Author: Jacobluke-

dabest/_api.py

@@ -1,3 +1,5 @@
+"""Loading data and relevant groups"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/load.ipynb.
 
 # %% auto 0

dabest/_dabest_object.py

@@ -1,3 +1,5 @@
+"""Main class for estimating statistics and generating plots."""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/dabest_object.ipynb.
 
 # %% auto 0

dabest/_delta_objects.py

@@ -1,3 +1,5 @@
+"""Auxiliary delta classes for estimating statistics and generating plots."""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/delta_objects.ipynb.
 
 # %% auto 0

dabest/_effsize_objects.py

@@ -1,3 +1,5 @@
+"""The auxiliary classes involved in the computations of bootstrapped effect sizes."""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/effsize_objects.ipynb.
 
 # %% auto 0

dabest/_stats_tools/confint_1group.py

@@ -1,3 +1,5 @@
+"""A range of functions to compute bootstraps for a single sample."""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/confint_1group.ipynb.
 
 # %% auto 0

dabest/_stats_tools/confint_2group_diff.py

@@ -1,3 +1,5 @@
+"""A range of functions to compute bootstraps for the mean difference"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/confint_2group_diff.ipynb.
 
 # %% auto 0

dabest/_stats_tools/effsize.py

@@ -1,3 +1,5 @@
+"""A range of functions to compute various effect sizes."""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../../nbs/API/effsize.ipynb.
 
 # %% ../../nbs/API/effsize.ipynb 4

dabest/forest_plot.py

@@ -1,3 +1,5 @@
+"""Creating forest plots from contrast objects."""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/forest_plot.ipynb.
 
 # %% auto 0

dabest/misc_tools.py

@@ -1,3 +1,5 @@
+"""Convenience functions that don't directly deal with plotting or bootstrap computations are placed here."""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/misc_tools.ipynb.
 
 # %% auto 0

dabest/plot_tools.py

@@ -1,3 +1,5 @@
+"""A set of convenience functions used for producing plots in `dabest`."""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/API/plot_tools.ipynb.
 
 # %% ../nbs/API/plot_tools.ipynb 2