Coverage for src/pytkdocs/parsers/docstrings/markdown.py: 85.71%

Shortcuts on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

5 statements  

1"""This module defines functions and classes to parse docstrings into structured data.""" 

2 

3from typing import List 

4 

5from pytkdocs.parsers.docstrings.base import Parser, Section 

6 

7 

8class Markdown(Parser): 

9 """A Markdown docstrings parser.""" 

10 

11 def parse_sections(self, docstring: str) -> List[Section]: # noqa: D102 

12 return [Section(Section.Type.MARKDOWN, docstring)]