Changeset 790c411 in rattail


Ignore:
Timestamp:
06/13/18 20:37:13 (2 years ago)
Author:
Lance Edgar <lance@…>
Branches:
master
Children:
2f78be1
Parents:
870fac5
Message:

Add docstrings for Category table

File:
1 edited

Legend:

Unmodified
Added
Removed
  • rattail/db/model/org.py

    r870fac5 r790c411  
    9999
    100100    uuid = uuid_column()
    101     number = sa.Column(sa.Integer())
    102     code = sa.Column(sa.String(length=8), nullable=True)
    103     name = sa.Column(sa.String(length=50))
     101
     102    code = sa.Column(sa.String(length=8), nullable=True, doc="""
     103    Unique code for the category, as string.
     104    """)
     105
     106    number = sa.Column(sa.Integer(), nullable=True, doc="""
     107    Number for the category.  NOTE: Most code leverages the :attr:`code`
     108    instead of this number, which is essentially ignored.
     109    """)
     110
     111    name = sa.Column(sa.String(length=50), nullable=True, doc="""
     112    Descriptive name for the category.
     113    """)
     114
    104115    department_uuid = sa.Column(sa.String(length=32))
    105 
    106     department = orm.relationship(Department)
     116    department = orm.relationship(Department, doc="""
     117    Reference to the :class:`Department` to which this category belongs, if
     118    applicable.
     119    """)
    107120
    108121    def __str__(self):
Note: See TracChangeset for help on using the changeset viewer.