Comments (3)
jshwi
commented on May 30, 2024
1
Hi @hhalaby, I would base the priority for other styles of docstring on demand, so thank you for opening this issue. Considering you've shown interest in support for numpy I will see what I can do (a formatter that can evaluate different syntax rules would be helpful for extensibility). If you have any ideas as well I always welcome a pull request.
from docsig.
jshwi
commented on May 30, 2024
1
@hhalaby I'll merge this one for now, feel free to reopen if you find anything amiss
from docsig.
jshwi
commented on May 30, 2024
Hi @hhalaby feel free to clone and try out this branch, I've added unittests, but haven't got any numpy docstrings to test it on live, would appreciate any feedback if you find the time
from docsig.
Related Issues (20)
- args and kwargs are not recognized as generic arguments HOT 2
- Positional-only arguments not recognized HOT 3
- Enhancement suggestion: Add capability to check __init__ document in its own docstring HOT 3
- docsig doesn't seem to support `@typing.overload`-ed functions/methods well HOT 2
- `@typing.overload`-ed methods not supported HOT 1
- Sphinx 7.0 compatibility HOT 4
- Second layer defined functions seem not to be checked HOT 4
- Support for Python 3.7.x HOT 4
- Optinal return statements with overload function result in docsig error E104 HOT 2
- Parameter and return value is not correctly recognized HOT 8
- Feature request - pre-commit integration & links HOT 4
- Report when the parameter is spelled wrongly HOT 3
- Add linkable path
- False positive when return annotation is a string HOT 2
- Skip checking for one line docstings HOT 2
- Handling of *args and **kwargs HOT 7
- `docsig -v` doesn't print version
- Issue with pre-commit integration
- Import error on `sphinxcontrib.napoleon` on Python 3.10.8 HOT 6
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 docsig.