Skip to content

Commit 7edeba4

Browse files
📝 Update docstring styles in README
1 parent 6749ba2 commit 7edeba4

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
# Python Docstring Highlighter
22

3-
![GitHub](https://img.shields.io/github/license/rodolphebarbanneau/python-docstring-highlighter)
4-
![GitHub release (latest by date)](https://img.shields.io/github/v/release/rodolphebarbanneau/python-docstring-highlighter)
5-
![GitHub issues](https://img.shields.io/github/issues-raw/rodolphebarbanneau/python-docstring-highlighter)
3+
![GitHub issues](https://img.shields.io/badge/style-google-green)
4+
![GitHub issues](https://img.shields.io/badge/style-numpy-green)
5+
![GitHub issues](https://img.shields.io/badge/style-sphinx-green)
6+
![GitHub issues](https://img.shields.io/badge/style-docblockr-red)
67

78
## Features
89

910
This extension is designed to **highlight docstrings** in **Python code**, making it easier to read and understand the source code. It does not provide any support for editing or creating docstrings. It is optimized for the **Google**, **NumPy**, and **Sphinx** styles docstring format, though it should work partially with other formats as well.
1011

11-
![Demo](https://github.com/rodolphebarbanneau/python-docstring-highlighter/blob/main/assets/docstring.gif)
12+
![Demo](https://raw.githubusercontent.com/rodolphebarbanneau/python-docstring-highlighter/main/assets/docstring.gif)
1213

1314
> **Technical Note**: The highlighting uses the VScode TextMate grammar injection feature, which means that it is compatible with any color theme and should not lead to performance issues (i.e. no custom scripts is executed). The extension uses a custom grammar to match the docstring patterns and inject the appropriate scopes into the code editor.
1415

0 commit comments

Comments
 (0)