From 12fc23f00fcb14df59d6d12ea910ea45259a8ecb Mon Sep 17 00:00:00 2001 From: Tim Huegerich Date: Fri, 11 Oct 2024 15:33:05 -0500 Subject: [PATCH] Update from latest nbdev_prepare --- nbstata/browse.py | 2 ++ nbstata/cell.py | 2 ++ nbstata/code_utils.py | 2 ++ nbstata/completion_env.py | 2 ++ nbstata/completions.py | 2 ++ nbstata/config.py | 2 ++ nbstata/inspect.py | 2 ++ nbstata/install.py | 2 ++ nbstata/kernel.py | 2 ++ nbstata/magics.py | 2 ++ nbstata/misc_utils.py | 2 ++ nbstata/noecho.py | 2 ++ nbstata/pandas.py | 2 ++ nbstata/stata.py | 2 ++ nbstata/stata_more.py | 2 ++ nbstata/stata_session.py | 2 ++ 16 files changed, 32 insertions(+) diff --git a/nbstata/browse.py b/nbstata/browse.py index a646e74..787fafe 100644 --- 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 index fd77beb..f24f35e 100644 --- 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 index 649bb46..38bc05f 100644 --- 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 index 6aa8728..a01f9fd 100644 --- 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 index 81d82c2..5835b81 100644 --- 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 index 452eb7f..a9999bf 100644 --- 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 index 75e2e02..8c01502 100644 --- 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 index c403084..7e99a58 100644 --- 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 index 7e089ed..53cb844 100644 --- 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 index 5b56a0a..293aed6 100644 --- 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 index fa50257..b10b7ed 100644 --- 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 index 3cdb57c..1725363 100644 --- 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 index f16284a..e856b0a 100644 --- 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 index ca90b7f..707d98a 100644 --- 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 index 1a1888c..4e04465 100644 --- 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 index edbb107..84f4004 100644 --- 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