Comments (2)
You should be able to define your own dense version with the new custom templating: https://github.com/NilsJPWerner/autoDocstring#custom-docstring-templates
Let me know if you have any problems.
from autodocstring.
I was able to produce what I wanted with the following custom template.
{{! Custom Docstring Template }}
{{summaryPlaceholder}}
{{extendedSummaryPlaceholder}}
{{#args}}
:param {{typePlaceholder}} {{var}}: {{descriptionPlaceholder}}
{{/args}}
{{#kwargs}}
:param {{typePlaceholder}} {{var}}: {{descriptionPlaceholder}}, optional, defaults to {{&default}}
{{/kwargs}}
{{#exceptions}}
:raises {{type}}: {{descriptionPlaceholder}}
{{/exceptions}}
{{#returns}}
:return: {{descriptionPlaceholder}}
:rtype: {{typePlaceholder}}
{{/returns}}
Thanks for the feature.
from autodocstring.
Related Issues (20)
- [feature request] Enable use in types of files besides *.py
- exceptions may occur multiple times HOT 1
- Tab is not working to move to next editable object
- Parser gets confused with comments HOT 1
- Doesn't generate doctoring around comments using 3 quotes HOT 3
- [feature request] Update existing docstring HOT 1
- Extension host crashes
- module level google style docstring
- autodocstring
- return field should be named "returns"
- [feature request] add support for positional-only and keyword-only arguments
- Autocomplete python file metadata
- Extended summary missing HOT 1
- Update Node.js Version to 18 or Later used in Github actions
- [bug] Broken links in README.md
- [feature request] - Add setting to fold doc strings
- [feature request] - Create or update the docstring for the next declaration that preceeds the cursor
- python 3.12 generics support
- Regular code completion blocked by extension. HOT 1
- Empty doctrings being generated HOT 2
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 autodocstring.