From e596c6a1b7d2c820bcbea90c98d3fb138114ffce Mon Sep 17 00:00:00 2001 From: Mike Auty Date: Tue, 3 Jan 2017 23:06:39 +0000 Subject: [PATCH] Further documentation updates. --- volatility/framework/interfaces/objects.py | 8 ++++---- volatility/framework/objects/templates.py | 9 +++++---- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/volatility/framework/interfaces/objects.py b/volatility/framework/interfaces/objects.py index 2237aac7c..b62ef95cd 100644 --- a/volatility/framework/interfaces/objects.py +++ b/volatility/framework/interfaces/objects.py @@ -169,12 +169,12 @@ class Template(validity.ValidityRoutines): @property def vol(self): - """Returns a volatility information object, much like the :class:`ObjectInterface` provides""" + """Returns a volatility information object, much like the :class:`~volatility.framework.interfaces.objects.ObjectInformation` provides""" return ReadOnlyMapping(self._vol) @property def children(self): - """The children of this template (such as member types, subtypes and base_types where they are relevant). + """The children of this template (such as member types, sub-types and base-types where they are relevant). Used to traverse the template tree. """ return [] @@ -193,12 +193,12 @@ class Template(validity.ValidityRoutines): """Replaces `old_child` with `new_child` in the list of children""" def clone(self): - """Returns a copy of the original Template as constructed (without update_vol having been called)""" + """Returns a copy of the original Template as constructed (without `update_vol` additions having been made)""" clone = self.__class__(**self._vol.parents.new_child()) return clone def update_vol(self, **new_arguments): - """Updates the keyword arguments with values that will not be carried across to clones""" + """Updates the keyword arguments with values that will **not** be carried across to clones""" self._vol.update(new_arguments) def __getattr__(self, attr): diff --git a/volatility/framework/objects/templates.py b/volatility/framework/objects/templates.py index e53ca7aab..b6d65cbac 100644 --- a/volatility/framework/objects/templates.py +++ b/volatility/framework/objects/templates.py @@ -16,9 +16,10 @@ class ObjectTemplate(interfaces.objects.Template, validity.ValidityRoutines): This is effectively a method of currying, but adds more structure to avoid abuse. It also allows inspection of information that should already be known: - * Type size - * Members, etc - etc. + + * Type size + * Members + * etc """ def __init__(self, object_class = None, type_name = None, **arguments): @@ -50,7 +51,7 @@ class ObjectTemplate(interfaces.objects.Template, validity.ValidityRoutines): def __call__(self, context, object_info): """Constructs the object - Returns: an object adhereing to the Object interface + Returns: an object adhereing to the :class:`~volatility.framework.interfaces.objects.ObjectInterface` """ arguments = {} arguments.update(self.vol)