Skip to content

Commit bfae1c8

Browse files
committed
italics docstring
1 parent be9e624 commit bfae1c8

File tree

2 files changed

+12
-4
lines changed

2 files changed

+12
-4
lines changed

nbdev/showdoc.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -171,7 +171,7 @@ def _repr_markdown_(self):
171171
doc += f'{h} {self.nm}\n\n'
172172
sig = _wrap_sig(f"{self.nm} {_fmt_sig(self.sig)}") if self.sig else ''
173173
doc += f'{sig}'
174-
if self.docs: doc += f"\n\n{self.docs}"
174+
if self.docs: doc += f"\n\n*{self.docs}*"
175175
if self.dm.has_docment: doc += f"\n\n{self.dm}"
176176
return doc
177177
__repr__=__str__=_repr_markdown_
@@ -199,7 +199,7 @@ def _repr_html_(self):
199199
doc = '<hr/>\n'
200200
doc += f'<h{self.title_level}>{self.nm}</h{self.title_level}>\n'
201201
doc += f'<blockquote><pre><code>{self.nm}{_fmt_sig(self.sig)}</code></pre></blockquote>'
202-
if self.docs: doc += f"<p>{self.docs}</p>"
202+
if self.docs: doc += f"<p><i>{self.docs}</i></p>"
203203
return doc
204204

205205
def doc(self):

nbs/api/08_showdoc.ipynb

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -624,7 +624,7 @@
624624
" doc += f'{h} {self.nm}\\n\\n'\n",
625625
" sig = _wrap_sig(f\"{self.nm} {_fmt_sig(self.sig)}\") if self.sig else ''\n",
626626
" doc += f'{sig}'\n",
627-
" if self.docs: doc += f\"\\n\\n{self.docs}\"\n",
627+
" if self.docs: doc += f\"\\n\\n*{self.docs}*\"\n",
628628
" if self.dm.has_docment: doc += f\"\\n\\n{self.dm}\"\n",
629629
" return doc\n",
630630
" __repr__=__str__=_repr_markdown_"
@@ -973,7 +973,7 @@
973973
" doc = '<hr/>\\n'\n",
974974
" doc += f'<h{self.title_level}>{self.nm}</h{self.title_level}>\\n'\n",
975975
" doc += f'<blockquote><pre><code>{self.nm}{_fmt_sig(self.sig)}</code></pre></blockquote>'\n",
976-
" if self.docs: doc += f\"<p>{self.docs}</p>\"\n",
976+
" if self.docs: doc += f\"<p><i>{self.docs}</i></p>\"\n",
977977
" return doc\n",
978978
"\n",
979979
" def doc(self):\n",
@@ -1341,6 +1341,14 @@
13411341
"#|hide\n",
13421342
"import nbdev; nbdev. nbdev_export()"
13431343
]
1344+
},
1345+
{
1346+
"cell_type": "code",
1347+
"execution_count": null,
1348+
"id": "d478691b",
1349+
"metadata": {},
1350+
"outputs": [],
1351+
"source": []
13441352
}
13451353
],
13461354
"metadata": {

0 commit comments

Comments
 (0)