spacing

Author: jph00

CHANGELOG.md

@@ -339,7 +339,7 @@
 - fix exporting `patch_to` which is decorated with `staticmethod` ([#1100](https://github.com/fastai/nbdev/pull/1100)), thanks to [@seeM](https://github.com/seeM)
 - `show_doc` errors if a dependency in the `nbdev` group has a sub-dependency that isn't installed ([#1097](https://github.com/fastai/nbdev/issues/1097))
 - Running `nbdev_migrate` while upgrading removes nbdev2 compatible directives ([#1089](https://github.com/fastai/nbdev/issues/1089))
-- respect `#|hide` and `#|include: false` for showdoc ([#1079](https://github.com/fastai/nbdev/pull/1079)), thanks to [@hamelsmu](https://github.com/hamelsmu)
+- respect `#| hide` and `#| include: false` for showdoc ([#1079](https://github.com/fastai/nbdev/pull/1079)), thanks to [@hamelsmu](https://github.com/hamelsmu)
 - Export class to library but hide from documentation ([#1076](https://github.com/fastai/nbdev/issues/1076))
 - `nbdev_clean` removes widget state ([#1069](https://github.com/fastai/nbdev/issues/1069))
   - If widget state is present, it means the user had intentionally changed settings in their notebook editor.
@@ -493,7 +493,7 @@
 
 ### Bugs Squashed
 
-- Make sure `#|exec_doc` triggers an update even when there is no export or show_doc ([#906](https://github.com/fastai/nbdev/pull/906)), thanks to [@hamelsmu](https://github.com/hamelsmu)
+- Make sure `#| exec_doc` triggers an update even when there is no export or show_doc ([#906](https://github.com/fastai/nbdev/pull/906)), thanks to [@hamelsmu](https://github.com/hamelsmu)
 - allow nbdev directives to work with cell magic ([#905](https://github.com/fastai/nbdev/pull/905)), thanks to [@hamelsmu](https://github.com/hamelsmu)
 
 
@@ -572,7 +572,7 @@
 
 ### Bugs Squashed
 
-- #|exports directive does not show source code in the docs ([#822](https://github.com/fastai/nbdev/issues/822))
+- #| exports directive does not show source code in the docs ([#822](https://github.com/fastai/nbdev/issues/822))
 - nbdev commands fail when `doc_path` contains whitespace ([#813](https://github.com/fastai/nbdev/pull/813)), thanks to [@mone27](https://github.com/mone27)
 - `show_doc` html renderer is incorrectly formatted ([#808](https://github.com/fastai/nbdev/issues/808))
 - `show_doc` cell output is incorrectly styled ([#807](https://github.com/fastai/nbdev/issues/807))
@@ -595,7 +595,7 @@
 - `get_config` works without a settings file ([#768](https://github.com/fastai/nbdev/pull/768)), thanks to [@seeM](https://github.com/seeM)
 - add site url ([#767](https://github.com/fastai/nbdev/pull/767)), thanks to [@hamelsmu](https://github.com/hamelsmu)
 - add `show_src` to display rich source code ([#763](https://github.com/fastai/nbdev/pull/763)), thanks to [@seeM](https://github.com/seeM)
-- add support for `#|exports` ([#762](https://github.com/fastai/nbdev/issues/762))
+- add support for `#| exports` ([#762](https://github.com/fastai/nbdev/issues/762))
 - `nbdev_merge` prints info like `git merge` ([#753](https://github.com/fastai/nbdev/issues/753))
 - helpers to convert fp front matter to quarto front matter ([#750](https://github.com/fastai/nbdev/pull/750)), thanks to [@hamelsmu](https://github.com/hamelsmu)
 - Streamline default settings ([#747](https://github.com/fastai/nbdev/issues/747))

nbdev/quarto.py

@@ -70,7 +70,7 @@ def _sort(a):
     x,y = a
     if y.startswith('index.'): return x,'00'
     return a
-#|export
+#| export
 _def_file_re = r'\.(?:ipynb|qmd|html)$'
 
 @delegates(nbglob_cli)

nbs/api/01_config.ipynb

@@ -17,7 +17,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|default_exp config"
+    "#| default_exp config"
    ]
   },
   {
@@ -26,7 +26,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "from datetime import datetime\n",
     "from fastcore.docments import *\n",
     "from fastcore.utils import *\n",
@@ -47,7 +47,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "from fastcore.test import *\n",
     "import tempfile"
    ]
@@ -84,7 +84,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "_nbdev_home_dir = 'nbdev' # sub-directory of xdg base dir\n",
     "_nbdev_cfg_name = 'settings.ini'"
    ]
@@ -95,7 +95,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def _git_repo():\n",
     "    try: return repo_details(run('git config --get remote.origin.url'))[1]\n",
     "    except OSError: return"
@@ -107,7 +107,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "test_eq(_git_repo(), 'nbdev')\n",
     "with tempfile.TemporaryDirectory() as d, working_directory(d): test_is(_git_repo(), None)"
    ]
@@ -118,7 +118,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "\n",
     "# When adding a named default to the list below, be sure that that name\n",
     "# is also added to one of the sections in `_nbdev_cfg_sections` as well,\n",
@@ -176,7 +176,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def _get_info(owner, repo, default_branch='main', default_kw='nbdev'):\n",
     "    from ghapi.all import GhApi\n",
     "    api = GhApi(owner=owner, repo=repo, token=os.getenv('GITHUB_TOKEN'))\n",
@@ -199,7 +199,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "if os.getenv('GITHUB_ACTIONS') != 'true': # GITHUB_TOKEN in actions has limited scope.\n",
     "    _branch, _tags, _descrip = _get_info('fastai', 'fastai')\n",
     "    test_eq(_tags, 'colab deep-learning fastai gpu machine-learning notebooks python pytorch')\n",
@@ -213,7 +213,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def _fetch_from_git(raise_err=False):\n",
     "    \"Get information for settings.ini from the user.\"\n",
     "    res={}\n",
@@ -236,7 +236,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "#test_eq(_fetch_from_git(raise_err=True)['lib_name'], 'nbdev')"
    ]
   },
@@ -246,7 +246,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def _prompt_user(cfg, inferred):\n",
     "    \"Let user input values not in `cfg` or `inferred`.\"\n",
     "    res = cfg.copy()\n",
@@ -267,7 +267,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "# `repo` not printed - already exists in `cfg`\n",
     "# `user` printed - in `inferred` and not `cfg`\n",
     "test_stdout(lambda: _prompt_user({'user':None,'repo':'nbdev'},{'user':'fastai'}),\n",
@@ -280,7 +280,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def _cfg2txt(cfg, head, sections, tail=''):\n",
     "    \"Render `cfg` with commented sections.\"\n",
     "    nm = cfg.d.name\n",
@@ -299,7 +299,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "d = {'user': 'fastai', 'repo': 'nbdev', 'doc_path': '_docs'}\n",
     "c = Config('.', 'test_settings.ini', d, save=False)\n",
     "txt = '''[DEFAULT]\n",
@@ -321,7 +321,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "_nbdev_cfg_head = '''# All sections below are required unless otherwise specified.\n",
     "# See https://github.com/AnswerDotAI/nbdev/blob/main/settings.ini for examples.\n",
     "\n",
@@ -345,7 +345,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "@call_parse\n",
     "@delegates(_apply_defaults, but='cfg')\n",
     "def nbdev_create_config(\n",
@@ -401,7 +401,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def _nbdev_config_file(cfg_name=_nbdev_cfg_name, path=None):\n",
     "    cfg_path = Path.cwd() if path is None else Path(path)\n",
     "    return getattr(Config.find(cfg_name), 'config_file', cfg_path/cfg_name)"
@@ -413,7 +413,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "test_eq(_nbdev_config_file(), Path.cwd().parent.parent/'settings.ini')"
    ]
   },
@@ -423,7 +423,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def _xdg_config_paths(cfg_name=_nbdev_cfg_name):\n",
     "    xdg_config_paths = reversed([xdg_config_home()]+xdg_config_dirs())\n",
     "    return [o/_nbdev_home_dir/cfg_name for o in xdg_config_paths]"
@@ -435,7 +435,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def _type(t): return bool if t==bool_arg else t\n",
     "_types = {k:_type(v['anno']) for k,v in docments(_apply_defaults,full=True,returns=False).items() if k != 'cfg'}\n",
     "\n",
@@ -463,7 +463,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "try: _get_config,get_config = get_config,get_config.__wrapped__ # Bypass cache during dev and tests\n",
     "except AttributeError: pass"
    ]
@@ -581,7 +581,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def config_key(c, default=None, path=True, missing_ok=None):\n",
     "    \"Deprecated: use `get_config().get` or `get_config().path` instead.\"\n",
     "    warn(\"`config_key` is deprecated. Use `get_config().get` or `get_config().path` instead.\", DeprecationWarning)\n",
@@ -601,7 +601,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def is_nbdev(): return _nbdev_config_file().exists()"
    ]
   },
@@ -611,7 +611,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "test_eq(is_nbdev(), True)"
    ]
   },
@@ -621,7 +621,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def create_output(txt, mime):\n",
     "    \"Add a cell output containing `txt` of the `mime` text MIME sub-type\"\n",
     "    return [{\"data\": { f\"text/{mime}\": str(txt).splitlines(True) },\n",
@@ -634,7 +634,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def show_src(src, lang='python'): return Markdown(f'```{lang}\\n{src}\\n```')"
    ]
   },
@@ -697,7 +697,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "_re_version = re.compile(r'^__version__\\s*=.*$', re.MULTILINE)\n",
     "_re_proj = re.compile(r'^name\\s*=\\s*\".*$', re.MULTILINE)\n",
     "_re_reqpy = re.compile(r'^requires-python\\s*=\\s*\".*$', re.MULTILINE)\n",
@@ -769,7 +769,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def write_cells(cells, hdr, file, offset=0, cell_number=True, solo_nb=False):\n",
     "    \"Write `cells` to `file` along with header `hdr` starting at index `offset` (mainly for nbdev internal use).\"\n",
     "    for cell in cells:\n",
@@ -784,7 +784,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|export\n",
+    "#| export\n",
     "def _basic_export_nb(fname, name, dest=None):\n",
     "    \"Basic exporter to bootstrap nbdev.\"\n",
     "    if dest is None: dest = get_config().lib_path\n",
@@ -820,7 +820,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "#|hide\n",
+    "#| hide\n",
     "#| eval: false\n",
     "path = Path('../nbdev')\n",
     "(path/'config.py').unlink(missing_ok=True)\n",