Update from latest nbdev_prepare

hugetim · hugetim · commit 12fc23f00fcb · 2024-10-11T15:33:05.000-05:00
diff --git a/nbstata/browse.py b/nbstata/browse.py
@@ -1,3 +1,5 @@
+"""Helpers for browse, head, and tail magics"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/07_browse.ipynb.
 
 # %% auto 0
diff --git a/nbstata/cell.py b/nbstata/cell.py
@@ -1,3 +1,5 @@
+"""Class representing a single code cell"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/13_cell.ipynb.
 
 # %% auto 0
diff --git a/nbstata/code_utils.py b/nbstata/code_utils.py
@@ -1,3 +1,5 @@
+"""Stata-related helper functions with no Jupyter or pystata dependence"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/04_code_utils.ipynb.
 
 # %% auto 0
diff --git a/nbstata/completion_env.py b/nbstata/completion_env.py
@@ -1,3 +1,5 @@
+"""Autocomplete helper: determine context of the token to be autocompleted"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/10_completion_env.ipynb.
 
 # %% auto 0
diff --git a/nbstata/completions.py b/nbstata/completions.py
@@ -1,3 +1,5 @@
+"""Autocomplete functionality"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/11_completions.ipynb.
 
 # %% auto 0
diff --git a/nbstata/config.py b/nbstata/config.py
@@ -1,3 +1,5 @@
+"""Utilities for loading Stata and nbstata"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/01_config.ipynb.
 
 # %% auto 0
diff --git a/nbstata/inspect.py b/nbstata/inspect.py
@@ -1,3 +1,5 @@
+"""Provides output for kernel.do_inspect()"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/12_inspect.ipynb.
 
 # %% auto 0
diff --git a/nbstata/install.py b/nbstata/install.py
@@ -1,3 +1,5 @@
+"""nbstata kernel install script"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/15_install.ipynb.
 
 # %% auto 0
diff --git a/nbstata/kernel.py b/nbstata/kernel.py
@@ -1,3 +1,5 @@
+"""IPythonKernel based on pystata"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/14_kernel.ipynb.
 
 # %% auto 0
diff --git a/nbstata/magics.py b/nbstata/magics.py
@@ -1,3 +1,5 @@
+"""IPython magics for nbstata"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/09_magics.ipynb.
 
 # %% auto 0
diff --git a/nbstata/misc_utils.py b/nbstata/misc_utils.py
@@ -1,3 +1,5 @@
+"""General helper functions with no Jupyter or pystata dependence"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/00_misc_utils.ipynb.
 
 # %% auto 0
diff --git a/nbstata/noecho.py b/nbstata/noecho.py
@@ -1,3 +1,5 @@
+"""For running multi-line Stata code without echoing the commands"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/05_noecho.ipynb.
 
 # %% auto 0
diff --git a/nbstata/pandas.py b/nbstata/pandas.py
@@ -1,3 +1,5 @@
+"""Stata-to-pandas utilities, used in `nbstata.browse`"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/06_pandas.ipynb.
 
 # %% auto 0
diff --git a/nbstata/stata.py b/nbstata/stata.py
@@ -1,3 +1,5 @@
+"""Simple wrappers for `pystata`/`sfi` functionality"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/02_stata.ipynb.
 
 # %% auto 0
diff --git a/nbstata/stata_more.py b/nbstata/stata_more.py
@@ -1,3 +1,5 @@
+"""Helper functions that expand on `pystata`/`sfi` functionality"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/03_stata_more.ipynb.
 
 # %% auto 0
diff --git a/nbstata/stata_session.py b/nbstata/stata_session.py
@@ -1,3 +1,5 @@
+"""A class for representing a Stata session"""
+
 # AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/08_stata_session.ipynb.
 
 # %% auto 0

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""Helpers for browse, head, and tail magics"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/07_browse.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""Class representing a single code cell"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/13_cell.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""Stata-related helper functions with no Jupyter or pystata dependence"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/04_code_utils.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""Autocomplete helper: determine context of the token to be autocompleted"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/10_completion_env.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""Autocomplete functionality"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/11_completions.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""Utilities for loading Stata and nbstata"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/01_config.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""Provides output for kernel.do_inspect()"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/12_inspect.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""nbstata kernel install script"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/15_install.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""IPythonKernel based on pystata"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/14_kernel.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+"""IPython magics for nbstata"""`
	`2`	`+`
`1`	`3`	`# AUTOGENERATED! DO NOT EDIT! File to edit: ../nbs/09_magics.ipynb.`
`2`	`4`
`3`	`5`	`# %% auto 0`