Comments (4)
In my case, as can be seen below, Returns
section doesn't get generated if the current cursor location is on a proper level of indentation (inside the functions's block), but it gets generated if it's on an improper level of indentation (outside of the function's block, e.g. at a class' or module's level).
Version: 1.31.1 (system setup)
Commit: 1b8e8302e405050205e69b59abb3559592bb9e60
Date: 2019-02-12T02:20:54.427Z
Electron: 3.1.2
Chrome: 66.0.3359.181
Node.js: 10.2.0
V8: 6.6.346.32
OS: Windows_NT x64 6.1.7601
autodocstring 0.2.3
Platform: Windows 7 64-bit
from autodocstring.
Hello auth:
def test1(msg):
|index1
return msg
def test2(msg):
|index2
return msg
when I use "ctrl+shift+2" in index1,I can't see return
but I use "ctrl+shift+2" in index2,I can see return
It is not comfortable
I can't speak English,sorry!
from autodocstring.
Hi, i have the same problem... it looks that other """ comments """ affect the correct detection of the docstring...
i have the next function:
def get_db_size(array,bytekey,datatypekey):
for eachdb in array:
seq,length = [x[bytekey] for x in eachdb],[x[datatypekey] for x in eachdb]
floatseq = map(float, seq)
idx = floatseq.index(max(floatseq))
lastByte = int(max(floatseq))+(offsets[length[idx]])
print eachdb
"""
print "seq:%s"%type(seq)
print seq
"""
return lastByte
and when i use the keyboard shortcut, i only get this docString:
"""get_db_size [summary]
[description]
Args:
array ([type]): [description]
bytekey ([type]): [description]
datatypekey ([type]): [description]
"""
without "return"... but... if i remove:
"""
print "seq:%s"%type(seq)
print seq
"""
then i can get the full docstring:
"""get_db_size [summary]
[description]
Args:
array ([type]): [description]
bytekey ([type]): [description]
datatypekey ([type]): [description]
Returns:
[type]: [description]
"""
from autodocstring.
@z33kz33k @NilsJPWerner This happens only when using CRLF if you use LF it works on indentation level as well. The cause of this behaviour is that indentationOf()
returns "one to much" e.g. 5 instead of 4 for CRLF.
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.