Skip to content

Commit

Permalink
Add some little docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
Shir0kamii committed Mar 29, 2018
1 parent bbe86b9 commit 294fd18
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions thingy.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ def __get__(self, instance, cls):


class View(object):
"""Transform an :class:`object` into a dict
:param bool defaults: Include attributes of object
:param list include: A list of properties to include
:param list exclude: A list of attributes to exclude
:param bool ordered: Use an :class:`OrderedDict` instead
"""

def __init__(self, defaults=False, include=None, exclude=None,
ordered=False):
Expand Down Expand Up @@ -78,6 +85,7 @@ def getclassattr(instance, attr):

@six.add_metaclass(ThingyMetaClass)
class Thingy(object):
"""Allows you to use object notation instead of dict notation"""
_view_cls = View
_silent = True

Expand Down

0 comments on commit 294fd18

Please sign in to comment.