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

keyword documentation is inconsistent #13

Closed
opalmer opened this issue Jul 28, 2015 · 0 comments
Closed

keyword documentation is inconsistent #13

opalmer opened this issue Jul 28, 2015 · 0 comments
Labels
Milestone

Comments

@opalmer
Copy link
Owner

opalmer commented Jul 28, 2015

The keyword documentation is inconsistent in a few places. For a function such as:

def foobar(a, b=None):
    pass

It should be expected to be documented like this:

def foobar(a, b=None):
    """
    Something about this function

    :param type a:
        About parameter a.

    :keyword type b:
        About keyword b
    """

Currently however there's a function functions which don't use the keyword directive.

@opalmer opalmer added the bug label Jul 28, 2015
@opalmer opalmer added this to the 0.1.0 milestone Jul 28, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant