Skip to content

Add badges to README.md #63

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stefmolin merged 5 commits into from
Oct 25, 2025
Merged

Add badges to README.md #63

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6589071
Capture start and end lines of empty docstrings in order to exclude t…
stefmolin Jul 13, 2025
3c676e9
Account for lines that need to be skipped on file rewrites
stefmolin Jul 13, 2025
bcbbfbc
Add badges to README.md
stefmolin Jul 13, 2025
e3b2184
Merge branch 'main' into readme-badges
stefmolin Oct 25, 2025
a8e8411
Clean up README.md formatting
stefmolin Oct 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,48 @@
# Docstringify
Flag missing docstrings and, optionally, generate them from signatures and type annotations.

<table>
<tr>
<td>
<img alt="Last Release" src="https://img.shields.io/badge/last%20release-inactive?style=for-the-badge">
</td>
<td>
<a href="https://pypi.org/project/docstringify/" target="_blank" rel="noopener noreferrer">
<img alt="PyPI release" src="https://img.shields.io/pypi/v/docstringify.svg">
</a>
<a href="https://pypi.org/project/docstringify/" target="_blank" rel="noopener noreferrer">
<img alt="Supported Python Versions" src="https://img.shields.io/pypi/pyversions/docstringify">
</a>
<a href="https://github.com/stefmolin/docstringify/blob/main/LICENSE" target="_blank" rel="noopener noreferrer">
<img alt="License" src="https://img.shields.io/pypi/l/docstringify.svg?color=blueviolet">
</a>
</td>
</tr>
<tr>
<td>
<img alt="Build status" src="https://img.shields.io/badge/build%20status-inactive?style=for-the-badge">
</td>
<td>
<!-- <a href="https://codecov.io/gh/stefmolin/docstringify" target="_blank" rel="noopener noreferrer">
<img alt="codecov" src="https://codecov.io/gh/stefmolin/docstringify/branch/main/graph/badge.svg?token=3SEEG9SZQO">
</a> -->
<a href="https://github.com/stefmolin/docstringify/actions/workflows/ci.yml" target="_blank" rel="noopener noreferrer">
<img alt="CI" src="https://github.com/stefmolin/docstringify/actions/workflows/ci.yml/badge.svg">
</a>
</td>
</tr>
<tr>
<td>
<img alt="Downloads" src="https://img.shields.io/badge/%23downloads-inactive?style=for-the-badge">
</td>
<td>
<a href="https://pypi.org/project/docstringify/" target="_blank" rel="noopener noreferrer">
<img alt="PyPI downloads" src="https://img.shields.io/pepy/dt/docstringify?label=pypi&color=blueviolet">
</a>
</td>
</tr>
</table>

## About

Given a file, `test.py`, with the following contents:
Expand Down
Loading