Method docstring showing for object attributes
Closed this issue · 7 comments
Currently, running dyc start not only prompts for the methods in the file, but also it's attributes, I'm not sure if this is desired, if it is go ahead and close this issue.
Example:
Would this be appropriate as default?
Hello @mboekhold
I can't reproduce your problem, can you please give a step by step, python version and the code you want to document?
@vccolombo run dyc start in the project's root folder with an active virtual env, I was able to print the filenames to get make it a bit clearer. this is the result:
@mboekhold - I was also unable to reproduce that on two Virtualenvs. One on 37 and 27
Please check the GIF below.
In addition to it, just incase methods needs to be avoided. these can be added in the ignore key?
That's strange, any idea why I'm getting a different result?
Looks like you created your venv directory inside dyc folder. DYC is recursively trying to document every file from your current directory. It then enters venv directory and tries to document its methods.
Currently, running dyc start not only prompts for the methods in the file, but also it's attributes
Are you sure about that? If you look at the file it is trying to document, I think all of them are actually methods, e.g.def __len__(self): return 1 << 31 in venv/lib/python3.6/site-packages/six.py
Can you please confirm you created your venv inside dyc directory? If so, what I prefer to do is to create a directory called dyc_dev, clone dyc inside it and create the venv inside dyc_dev like so:
dyc_dev
|
|-- venv
|-- dyc
You could also use Conda, like Zarad used in #13 (comment) . Also, note that the venv he used was in ~/ , a different directory from where he ran dyc start
I did indeed have my venv in my dyc dir, that makes sense, thank you @vccolombo