From 2a365f4d99e9e42a82fe638b2f2bbc1c8d1030ee Mon Sep 17 00:00:00 2001 From: Benny Malengier Date: Wed, 15 Jul 2009 09:16:39 +0000 Subject: [PATCH] improve docstrings svn: r12797 --- src/gen/lib/childreftype.py | 15 +++++++++++++++ src/gen/lib/eventtype.py | 4 ++-- 2 files changed, 17 insertions(+), 2 deletions(-) diff --git a/src/gen/lib/childreftype.py b/src/gen/lib/childreftype.py index 28e962325..97f6d81ef 100644 --- a/src/gen/lib/childreftype.py +++ b/src/gen/lib/childreftype.py @@ -40,6 +40,21 @@ from gen.lib.grampstype import GrampsType class ChildRefType(GrampsType): """ 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 diff --git a/src/gen/lib/eventtype.py b/src/gen/lib/eventtype.py index 6d29cb5d2..1e999a721 100644 --- a/src/gen/lib/eventtype.py +++ b/src/gen/lib/eventtype.py @@ -84,8 +84,8 @@ class EventType(GrampsType): .. attribute MARR_BANNS: Marriage Banns .. attribute ENGAGEMENT: Engagement .. attribute DIVORCE: Divorce - .. attribute DIV_FILING: Divorce Filing" - .. attribute ANNULMENT: Annulment" + .. attribute DIV_FILING: Divorce Filing + .. attribute ANNULMENT: Annulment .. attribute MARR_ALT: Alternate Marriage """ UNKNOWN = -1