diff --git a/volatility/framework/interfaces/automagic.py b/volatility/framework/interfaces/automagic.py index c49c30ba7..496b65ca0 100644 --- a/volatility/framework/interfaces/automagic.py +++ b/volatility/framework/interfaces/automagic.py @@ -13,7 +13,7 @@ from volatility.framework.configuration import requirements class AutomagicInterface(interfaces.configuration.ConfigurableInterface, metaclass = ABCMeta): - """Class that defines an automagic component that can help fulfill a Requirement + """Class that defines an automagic component that can help fulfill `Requirements` These classes are callable with the following parameters: @@ -60,9 +60,9 @@ class AutomagicInterface(interfaces.configuration.ConfigurableInterface, metacla requirement_type: Union[Tuple[Type[interfaces.configuration.RequirementInterface], ...], Type[ interfaces.configuration.RequirementInterface]], shortcut: bool = True) -> List[Tuple[str, interfaces.configuration.RequirementInterface]]: - """Determines if there is actually an unfulfilled requirement waiting + """Determines if there is actually an unfulfilled `Requirement` waiting - This ensures we do not carry out an expensive search when there is no requirement for a particular requirement + This ensures we do not carry out an expensive search when there is no need for a particular `Requirement` Args: context: Context on which to operate @@ -72,7 +72,7 @@ class AutomagicInterface(interfaces.configuration.ConfigurableInterface, metacla shortcut: Only returns requirements that live under unsatisfied requirements Returns: - A list of tuples containing the config_path, sub_config_path and requirement identifying the SymbolTableRequirements + A list of tuples containing the config_path, sub_config_path and requirement identifying the unsatisfied `Requirements` """ sub_config_path = interfaces.configuration.path_join(config_path, requirement_root.name) results = [] # type: List[Tuple[str, interfaces.configuration.RequirementInterface]] @@ -92,7 +92,7 @@ class StackerLayerInterface(metaclass = ABCMeta): """Class that takes a lower layer and attempts to build on it stack_order determines the order (from low to high) that stacking layers - should be attempted lower levels should have lower stack_orders + should be attempted lower levels should have lower `stack_orders` """ stack_order = 0 @@ -105,7 +105,7 @@ class StackerLayerInterface(metaclass = ABCMeta): """ Method to determine whether this builder can operate on the named layer. If so, modify the context appropriately. - Returns the name of any new_layer stacked on top of this layer or None. The stacking is therefore strictly + Returns the name of any new layer stacked on top of this layer or None. The stacking is therefore strictly linear rather than tree driven. Configuration options provided by the context are ignored, and defaults are to be used by this method diff --git a/volatility/framework/interfaces/configuration.py b/volatility/framework/interfaces/configuration.py index f61f56ef0..69d5adf1c 100644 --- a/volatility/framework/interfaces/configuration.py +++ b/volatility/framework/interfaces/configuration.py @@ -291,7 +291,7 @@ class RequirementInterface(metaclass = ABCMeta): Args: name: The name of the requirement description: A short textual description of the requirement - default: The default value for the requirement is none is provided + default: The default value for the requirement if no value is provided optional: Whether the requirement must be satisfied or not """ super().__init__() diff --git a/volatility/framework/interfaces/objects.py b/volatility/framework/interfaces/objects.py index b83ee7503..1056d431d 100644 --- a/volatility/framework/interfaces/objects.py +++ b/volatility/framework/interfaces/objects.py @@ -85,7 +85,7 @@ class ObjectInterface(metaclass = ABCMeta): def __init__(self, context: 'interfaces_context.ContextInterface', type_name: str, object_info: 'ObjectInformation', **kwargs) -> None: - """Constructs an Object adhereing to the ObjectInterface + """Constructs an Object adhering to the ObjectInterface Args: context: The context associated with the object @@ -267,7 +267,7 @@ class Template: @abstractmethod def has_member(self, member_name: str) -> bool: - """Returns whether the object would contain a member called member_name""" + """Returns whether the object would contain a member called `member_name`""" def clone(self) -> 'Template': """Returns a copy of the original Template as constructed (without `update_vol` additions having been made)""" diff --git a/volatility/framework/layers/intel.py b/volatility/framework/layers/intel.py index 4dc141b33..ac9629a53 100644 --- a/volatility/framework/layers/intel.py +++ b/volatility/framework/layers/intel.py @@ -9,7 +9,7 @@ import math import struct from typing import Any, Dict, Iterable, List, Optional, Tuple -from volatility import framework, classproperty +from volatility import classproperty from volatility.framework import exceptions, interfaces from volatility.framework.configuration import requirements from volatility.framework.layers import linear