Skip to content

Commit 844dac8

Browse files
authored
Add badges
1 parent e48356c commit 844dac8

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# docstring-to-markdown
22

33
[![tests](https://github.com/krassowski/jupyterlab-lsp/workflows/tests/badge.svg)](https://github.com/krassowski/docstring-to-markdown/actions?query=workflow%3A%22tests%22)
4+
![CodeQL](https://github.com/krassowski/data-vault/workflows/CodeQL/badge.svg)
5+
[![pypi-version](https://img.shields.io/pypi/v/docstring-to-markdown.svg)](https://python.org/pypi/docstring-to-markdown)
46

57
On the fly conversion of Python docstrings to markdown
68

@@ -22,14 +24,16 @@ Convert reStructuredText:
2224
```python
2325
>>> import docstring_to_markdown
2426
>>> docstring_to_markdown.convert(':math:`\\sum`')
25-
$\\sum$
27+
'$\\sum$'
2628
```
2729

2830
When given the format cannot be recognised an exception will be raised:
2931

3032
```python
3133
>>> docstring_to_markdown.convert('\\sum')
32-
UnknownFormatError()
34+
Traceback (most recent call last):
35+
raise UnknownFormatError()
36+
docstring_to_markdown.UnknownFormatError
3337
```
3438

3539
### Development

0 commit comments

Comments
 (0)