Skip to content

Commit ba5ea1e

Browse files
committed
update docstring
1 parent 9cf56d3 commit ba5ea1e

File tree

2 files changed

+15
-3
lines changed

2 files changed

+15
-3
lines changed

nbdev/quarto.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -251,7 +251,7 @@ def _save_cached_readme(cache, cfg):
251251
def nbdev_readme(
252252
path:str=None, # Path to notebooks
253253
chk_time:bool=False): # Only build if out of date
254-
"Generate README.md from index.ipynb"
254+
"Create README.md from readme_nb (index.ipynb by default)"
255255
cfg = get_config()
256256
path = Path(path) if path else cfg.nbs_path
257257
if chk_time and _readme_mtime_not_older(cfg.config_path/'README.md', path/cfg.readme_nb): return

nbs/api/14_quarto.ipynb

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -476,7 +476,7 @@
476476
"def nbdev_readme(\n",
477477
" path:str=None, # Path to notebooks\n",
478478
" chk_time:bool=False): # Only build if out of date\n",
479-
" \"Generate README.md from index.ipynb\"\n",
479+
" \"Create README.md from readme_nb (index.ipynb by default)\"\n",
480480
" cfg = get_config()\n",
481481
" path = Path(path) if path else cfg.nbs_path\n",
482482
" if chk_time and _readme_mtime_not_older(cfg.config_path/'README.md', path/cfg.readme_nb): return\n",
@@ -666,9 +666,21 @@
666666
],
667667
"metadata": {
668668
"kernelspec": {
669-
"display_name": "python3",
669+
"display_name": "Python 3 (ipykernel)",
670670
"language": "python",
671671
"name": "python3"
672+
},
673+
"language_info": {
674+
"codemirror_mode": {
675+
"name": "ipython",
676+
"version": 3
677+
},
678+
"file_extension": ".py",
679+
"mimetype": "text/x-python",
680+
"name": "python",
681+
"nbconvert_exporter": "python",
682+
"pygments_lexer": "ipython3",
683+
"version": "3.10.12"
672684
}
673685
},
674686
"nbformat": 4,

0 commit comments

Comments
 (0)