Skip to content

Feature request: Support docstring #33

Description

@2xyo

It would be great to be able to add comments for methods and class and have the ability to get the documentation from __doc__ method attribut. Something like this:

class UserResource(Resource):
    """
    My doc... 
    """
    actions = {
        "search": {"method": "GET", "url": "users/search","doc":"Search users"},
        "retrieve": {"method": "GET", "url": "users/{}", "doc": "Search a user X. X should be a username"},
    }

instagram_api.add_resource(resource_name="users", resource_class=UserResource)

help(instagram_api.users)
help(instagram_api.users.search)
help(instagram_api.users.retrieve)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions