Last active
March 14, 2017 20:05
-
-
Save marksharrison/8c5f3b06c373c2fed171f9c9b8728405 to your computer and use it in GitHub Desktop.
function_template with Google Style Docstrings Python Snippet
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
#!/usr/bin/env python3 | |
# -*- coding: utf-8 -*- | |
# pylint: disable=line-too-long | |
def function_template(first_argument, second_argument=None, *args, **kwargs): | |
"""Summary description of function. | |
Extended description of function. | |
Args: | |
first_argument (int): The first numeric parameter. | |
second_argument (str, optional): The second numeric parameter. Defaults to None. | |
*args: Variable length argument list. | |
**kwargs: Arbitrary keyword arguments. | |
Returns: | |
bool: The return value. True for success, False otherwise. | |
Raises: | |
""" | |
return True |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment