FlareStart
HomeNewsHow ToSources
FlareStart

Where developers start their day. All the tech news & tutorials that matter, in one place.

Quick Links

  • Home
  • News
  • Tutorials
  • Sources
  • Privacy Policy

Connect

© 2026 FlareStart. All rights reserved.

Back to articles
How docvet learned to read Sphinx and NumPy docstrings
How-ToProgramming Languages

How docvet learned to read Sphinx and NumPy docstrings

via Dev.to PythonAlberto Nieto1d ago

The problem: one inspector, one language docvet checks whether your Python docstrings are present, complete, accurate, and renderable. Since v1.0, it's caught missing Raises: sections, stale docstrings after code changes, broken mkdocs rendering, and more — 22 rules across five check modules. But it only understood Google-style. That's a problem, because a huge portion of the Python ecosystem uses something else: Sphinx/RST style ( :param name: , :returns: , :raises: ) — Django, Flask, SQLAlchemy, requests, boto3, CPython stdlib NumPy style (underlined section headers) — NumPy, SciPy, pandas, scikit-learn, matplotlib If you maintain a Django app or a scientific Python library, docvet's enrichment checks couldn't parse your docstrings. As of v1.13.0, that's fixed. How style support works It's a project-level setting, not auto-detection docvet doesn't guess your style per-file. You tell it once in pyproject.toml : [tool.docvet] docstring-style = "sphinx" Two valid options: "google" (defa

Continue reading on Dev.to Python

Opens in a new tab

Read Full Article
0 views

Related Articles

How to Prevent Merge Conflicts When Multiple Teams Work in the Same Codebase
How-To

How to Prevent Merge Conflicts When Multiple Teams Work in the Same Codebase

Medium Programming • 19h ago

How One Hour of Planning Makes the Whole Week Feel Easier
How-To

How One Hour of Planning Makes the Whole Week Feel Easier

Medium Programming • 1d ago

Multi‑File Magic: 8 Claude Code Commands for Safe, Large‑Scale Codebase Changes
How-To

Multi‑File Magic: 8 Claude Code Commands for Safe, Large‑Scale Codebase Changes

Medium Programming • 1d ago

What Learning to Code Actually Feels Like (No One Talks About This)
How-To

What Learning to Code Actually Feels Like (No One Talks About This)

Medium Programming • 1d ago

How to Run Ethernet Cables to Your Router and Keep Them Tidy
How-To

How to Run Ethernet Cables to Your Router and Keep Them Tidy

Wired • 1d ago

Discover More Articles