Comments (1)
tristanlatr
commented on July 4, 2024
The state of python docstrings standard is pretty bad: no one agrees on a standard.
I believe pydoctor should have a lint mode integrated to the CLI. When activated, it won't produce any HTML, only parse all docstrings and generate docstrings stans to warn on link not founds errors and other parsing errors.
from pydoctor.
Related Issues (20)
- Build infrastructure: Run ReadTheDocs on every PR/commit? HOT 2
- Find an extensible manner to integrate templatewriter customizations
- How to break down (debug) " Cannot find link target for XYZ" errors? HOT 9
- Failure to process classifiers as part of consolidation fields in a reStructuredText docstring HOT 2
- Upgrade all annotations to use python 3.10 style HOT 1
- RFE: please provide update for `urllib3` 2.2.x HOT 5
- Fix compatibility with docutils 0.21.x
- Transform deprecated typing annotation into python 3.10 style HOT 1
- Codecov is failing HOT 7
- Docutils is slow for constructor links HOT 1
- Release automation is broken HOT 3
- Move away from appdirs package
- 24.3.3: pytest fails in `pydoctor/test/test_cyclic_imports_base_classes.py::test_cyclic_imports_base_classes` unit HOT 1
- Add support for the new doc micro syntax (PEP727)
- Do a real distinction in between the code model and the view model
- Add support for doc comments HOT 2
- HTML: Break function signature elements into multiple spans HOT 2
- Drop python 3.7
- Source code files are always assumed to be uft-8
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from pydoctor.