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

docstrings for tmpo-py #2

Open
saroele opened this issue Nov 23, 2014 · 0 comments
Open

docstrings for tmpo-py #2

saroele opened this issue Nov 23, 2014 · 0 comments

Comments

@saroele
Copy link
Member

saroele commented Nov 23, 2014

I vote for docstrings in tmpo-py. Now, some functions are unclear to me. We can write the docstrings while working on the unittest, both go hand-in-hand.

For docstrings, the following format is normally rendered well by most tools

def myfunc(self, arg1, arg2=200):
    """
    One line to describe what the function does

    Parameters
    ---------------
    * arg1 : Type of arg1
        Description of arg1 
    * arg2 : Integer (default=200)
        Description of arg2

    Returns  
    ----------
    res : type and description

    Raises
    ----------
    this is optional: a description of exceptions that can be raised

    Notes
    ----------
    A longer description of the function, with notes for using, implementation, details, etc. 
    """
icarus75 added a commit that referenced this issue Sep 28, 2015
Use requests_futures to sync
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant