From ca0b1d94b2907187e103407f5ce1fac4cf325823 Mon Sep 17 00:00:00 2001 From: Michael Lasevich Date: Mon, 19 Aug 2019 22:47:17 -0700 Subject: [PATCH] update docs --- src/quick_scheme/__init__.py | 2 +- src/quick_scheme/field.py | 15 ++++++++++++--- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/src/quick_scheme/__init__.py b/src/quick_scheme/__init__.py index d9d6000..67bc7b7 100644 --- a/src/quick_scheme/__init__.py +++ b/src/quick_scheme/__init__.py @@ -1,6 +1,6 @@ ''' QuickScheme Library Package ''' -from quick_scheme.field import Field +from .field import Field, FieldValue from .nodes import KeyBasedList from .nodes import ListOfNodes, ListOfReferences from .nodes import SchemeNode diff --git a/src/quick_scheme/field.py b/src/quick_scheme/field.py index 307033e..af9eace 100644 --- a/src/quick_scheme/field.py +++ b/src/quick_scheme/field.py @@ -17,7 +17,11 @@ class FieldValue(object): - ''' Field Value Holder ''' + ''' + Field Value Holder + + This object holds a specific value for a specific node + ''' def __init__(self, field, node): ''' @@ -93,6 +97,8 @@ def is_valid(self): class Field(object): ''' Basic Field ''' + + # Python version independent version of a string STR = STR def __init__(self, name, **kwargs): @@ -121,12 +127,15 @@ def __getattr__(self, item): @property def is_qs_node(self): - ''' Return true, if ftype is a QuickScheme node(derivative of SchemeBaseNode)''' + ''' + Returns true, if type for this field is a QuickScheme Node (i.e. a child of SchemeBaseNode) + ''' return issubclass(self.ftype, SchemeBaseNode) @property def has_default(self): - ''' Has default value ''' + ''' + Returns True if this field has a default value ''' default = self._data.get('default', None) return default is not None