improve docstrings
svn: r12797
This commit is contained in:
parent
098afdfb0a
commit
2a365f4d99
@ -40,6 +40,21 @@ from gen.lib.grampstype import GrampsType
|
|||||||
class ChildRefType(GrampsType):
|
class ChildRefType(GrampsType):
|
||||||
"""
|
"""
|
||||||
Provide the different ChildRef types.
|
Provide the different ChildRef types.
|
||||||
|
|
||||||
|
.. attribute NONE : None - no relationship
|
||||||
|
.. attribute BIRTH : Birth - relation by birth. Implicates genetic
|
||||||
|
relationship if no other families with other types are present
|
||||||
|
.. attribute ADOPTED : Adopted - adopted child. The real parents have
|
||||||
|
given up the child for adoption
|
||||||
|
.. attribute STEPCHILD : Stepchild - stepchild, the child is from the other
|
||||||
|
partner, relationship is due to the forming of the marriage
|
||||||
|
.. attribute SPONSORED : Sponsored - parent is sponsoring the child
|
||||||
|
.. attribute FOSTER : Foster - taking care of the child while the real
|
||||||
|
parents are around and know of it. This can be due to the parents
|
||||||
|
not being able to care for the child, or because government has
|
||||||
|
ordered this
|
||||||
|
.. attribute UNKNOWN : Unknown - unknown relationship
|
||||||
|
.. attribute CUSTOM : Custom - a relationship given by the user
|
||||||
"""
|
"""
|
||||||
|
|
||||||
NONE = 0
|
NONE = 0
|
||||||
|
@ -84,8 +84,8 @@ class EventType(GrampsType):
|
|||||||
.. attribute MARR_BANNS: Marriage Banns
|
.. attribute MARR_BANNS: Marriage Banns
|
||||||
.. attribute ENGAGEMENT: Engagement
|
.. attribute ENGAGEMENT: Engagement
|
||||||
.. attribute DIVORCE: Divorce
|
.. attribute DIVORCE: Divorce
|
||||||
.. attribute DIV_FILING: Divorce Filing"
|
.. attribute DIV_FILING: Divorce Filing
|
||||||
.. attribute ANNULMENT: Annulment"
|
.. attribute ANNULMENT: Annulment
|
||||||
.. attribute MARR_ALT: Alternate Marriage
|
.. attribute MARR_ALT: Alternate Marriage
|
||||||
"""
|
"""
|
||||||
UNKNOWN = -1
|
UNKNOWN = -1
|
||||||
|
Loading…
Reference in New Issue
Block a user