Skip to content

Commit 1fe2fe3

Browse files
committed
Docstring improvements
1 parent 16282a9 commit 1fe2fe3

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docstring_to_markdown/rst.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,8 @@ def __init__(self):
144144
@abstractmethod
145145
def can_parse(self, line: str) -> bool:
146146
"""
147-
All children should call _start_block in initiate_parsing() implementation.
148-
"""
147+
All children should call _start_block in initiate_parsing() implementation.
148+
"""
149149
pass
150150

151151
@abstractmethod
@@ -312,6 +312,7 @@ def rst_to_markdown(text: str):
312312
- https://www.python.org/dev/peps/pep-0287/
313313
- https://www.python.org/dev/peps/pep-0257/
314314
- https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_numpy.html
315+
- https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#literal-blocks
315316
316317
It is intended to improve the UX while better the solutions at the backend
317318
are being investigated rather than provide a fully-featured implementation.

0 commit comments

Comments
 (0)