Comments (11)
None
should now be hidden- reference to self is now removed
from neogen.
Last commit should fix it, a single line that did this lol. Is everything ok ?
from neogen.
nice xD good work!
from neogen.
Related: #41 (comment)
from neogen.
I think I just added support for type hints, and fixed the bug at the same time
Can you try it out ?
from neogen.
Thanks a lot @danymat!
This is what I'm getting, I think self
should not be a parameter
def __str__(self) -> str:
"""
Parameters
----------
self:
Returns
-------
str
"""
config_str = ""
for row in self.tile:
row_str = "".join(row)
config_str += row_str + "\n"
return config_str.strip()
from neogen.
I think the point about self
should also apply to classmethods
@classmethod
def test(cls) -> None:
"""
Parameters
----------
cls:
Returns
-------
None
"""
pass
I expect that cls should not be a parameter.
from neogen.
Also I think -> None
should not generate a return type, because that is the default value thats being returned by a function.
So rather than this:
def test(a: int) -> None:
"""
Parameters
----------
a: int
Returns
-------
int
None
"""
pass
I don't expect it to generate a doc for None returns.
def test(a: int) -> None:
"""
Parameters
----------
a: int
"""
pass
from neogen.
I think the point about
self
should also apply to classmethods@classmethod def test(cls) -> None: """ Parameters ---------- cls: Returns ------- None """ passI expect that cls should not be a parameter.
This seems to be a little bit difficult to do, I don't think I will do it tonight
from neogen.
Hello, I think that commit d46c438 did provide a very great handling of such self
, cls
cases. Can you take a look and try again ?
from neogen.
class Test:
@staticmethod
def test2(a: int, b: str):
"""
Parameters
----------
a: int
b: str
Returns
-------
int
str
"""
pass
@classmethod
def test(cls, a: int, b: str):
"""
Parameters
----------
a: int
b: str
Returns
-------
int
str
"""
pass
def test1(self, a: int, b: str):
"""
Parameters
----------
a: int
b: str
Returns
-------
int
str
"""
pass
Thanks @danymat I think that did fix the self and cls cases.
I think I've found another bug, some how its generating return int and str types.
from neogen.
Related Issues (20)
- Python bug - nested functions should not have their first parameter removed
- Empty types in jsdoc HOT 4
- Highlight groups of block after docstring changes after completion of final choice node HOT 1
- This structure cannot generate annotations through neogen
- Module 'neogen.types.template' not found
- Feature Request - Support NeoVim native snippet engine HOT 2
- `Invalid 'end_col': out of range` error whenever running `Neogen file` HOT 2
- Bug: handling of arbitrary args and kwargs with type hints HOT 1
- Allow generating explicit sections HOT 3
- Update / Correction command HOT 2
- Python - raise module_name.Error() is not detected
- Bug: Neogen not functioning in vue files. HOT 2
- Could not get neogen to work with LazyVim HOT 4
- Need unittests HOT 1
- Missing blank line in numpydoc
- Option to always disable writing argument types in Python HOT 2
- FR: support creating annotations in Markdown code blocks HOT 1
- Sometimes native snippets do not expand on tab
- Add support for records in C# HOT 2
- Support annotating interfaces 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 neogen.