Fix up the documentation and leave a note about cast accepting short type names.

This commit is contained in:
Mike Auty
2017-01-04 22:10:27 +00:00
parent f7fa45bc5c
commit 547a3d94bb
2 changed files with 8 additions and 3 deletions
+4 -1
View File
@@ -93,7 +93,10 @@ class ObjectInterface(validity.ValidityRoutines, metaclass = ABCMeta):
"""Writes the new value into the format at the offset the object currently resides at"""
def cast(self, new_type_name, **additional):
"""Returns a new object at the offset and from the layer that the current object inhabits"""
"""Returns a new object at the offset and from the layer that the current object inhabits
.. note:: If new type name does not include a symbol table, the symbol table for the current object is used
"""
# TODO: Carefully consider the implications of casting and how it should work
if constants.BANG not in new_type_name:
symbol_table = self.vol['type_name'].split(constants.BANG)[0]
+4 -2
View File
@@ -110,8 +110,10 @@ class Bytes(PrimitiveObject, bytes):
class String(PrimitiveObject, str):
"""Primitive Object that handles string values
length: specifies the maximum possible length that the string could hold within memory
(note: for multibyte characters, this will not be the maximum length of the string)
:param max_length: specifies the maximum possible length that the string could hold within memory
(for multibyte characters, this will not be the maximum length of the string)
:type max_length: int
"""
_struct_type = str