Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for PEP 484 #22

Closed
lunaluxie opened this issue Feb 2, 2018 · 1 comment
Closed

Support for PEP 484 #22

lunaluxie opened this issue Feb 2, 2018 · 1 comment

Comments

@lunaluxie
Copy link

lunaluxie commented Feb 2, 2018

Implementing PEP 484 would let the extension parse function-annotations to automatically fill in types.

For example, the generated doc-string for this annotated function is currently:

def foo(bar: str) -> str:
	"""[summary]
	
	Arguments:
		bar: str {[type]} -- [description]
	
	Returns:
		[type] -- [description]
	"""

	return bar

When it could have generated:

def foo(bar: str) -> str:
	"""[summary]
	
	Arguments:
		bar {str} -- [description]
	
	Returns:
		str -- [description]
	"""

	return bar
@lunaluxie lunaluxie changed the title Add support for PEP 484 Support for PEP 484 Feb 2, 2018
@lunaluxie lunaluxie mentioned this issue Feb 3, 2018
@NilsJPWerner
Copy link
Owner

This is now implemented. Sorry for the delay! :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants