Skip to content

Commit 16282a9

Browse files
committed
Fix some conversion quirks
1 parent f142799 commit 16282a9

File tree

1 file changed

+12
-11
lines changed

1 file changed

+12
-11
lines changed

docstring_to_markdown/rst.py

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -243,9 +243,9 @@ def can_consume(self, line: str) -> bool:
243243
return line.startswith('>>>') or line.startswith('...')
244244

245245
def consume(self, line: str):
246-
super().consume(self._stripPrompt(line))
246+
super().consume(self._strip_prompt(line))
247247

248-
def _stripPrompt(self, line: str) -> str:
248+
def _strip_prompt(self, line: str) -> str:
249249
start = 4 if line.startswith('>>> ') or line.startswith('... ') else 3
250250
return line[start:]
251251

@@ -308,15 +308,15 @@ def initiate_parsing(self, line: str, current_language: str) -> IBlockBeginning:
308308

309309
def rst_to_markdown(text: str):
310310
"""
311-
Try to parse docstrs in following formats to markdown:
312-
- https://www.python.org/dev/peps/pep-0287/
313-
- https://www.python.org/dev/peps/pep-0257/
314-
- https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html
311+
Try to parse docstrings in following formats to markdown:
312+
- https://www.python.org/dev/peps/pep-0287/
313+
- https://www.python.org/dev/peps/pep-0257/
314+
- https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html
315315
316-
It is intended to improve the UX while better the solutions at the backend
317-
are being investigated rather than provide a fully-featured implementation.
316+
It is intended to improve the UX while better the solutions at the backend
317+
are being investigated rather than provide a fully-featured implementation.
318318
319-
Supported features:
319+
Supported features:
320320
- code blocks:
321321
- PEP0257 (formatting of code with highlighting, formatting of output without highlighting)
322322
- after ::
@@ -326,8 +326,9 @@ def rst_to_markdown(text: str):
326326
- external links (inline only)
327327
- as subset of paragraph-level and inline directives (which must fit into a single line)
328328
329-
@param text - the input docstring
330-
"""
329+
Arguments:
330+
text - the input docstring
331+
"""
331332
language = 'python'
332333
markdown = ''
333334
active_parser: Union[IParser, None] = None

0 commit comments

Comments
 (0)