Skip to content

Commit 5d4c70d

Browse files
committed
Documentation: Fix requirements -> get_requirements #993
1 parent b050b10 commit 5d4c70d

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/source/using-as-a-library.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,10 @@ return a dictionary of plugin names and the plugin classes.
6767
Determine what configuration options a plugin requires
6868
------------------------------------------------------
6969

70-
For each plugin class, we can call the classmethod `requirements` on it, which will return a list of objects that
71-
adhere to the :py:class:`~volatility3.framework.interfaces.configuration.RequirementInterface` method. The various
72-
types of Requirement are split roughly in two,
70+
For each plugin class, we can call the classmethod
71+
:py:func:`~volatility3.framework.interfaces.configuration.ConfigurableInterface.get_requirements` on it, which will
72+
return a list of objects that adhere to the :py:class:`~volatility3.framework.interfaces.configuration.RequirementInterface`
73+
method. The various types of Requirement are split roughly in two,
7374
:py:class:`~volatility3.framework.interfaces.configuration.SimpleTypeRequirement` (such as integers, booleans, floats
7475
and strings) and more complex requirements (such as lists, choices, multiple requirements, translation layer
7576
requirements or symbol table requirements). A requirement just specifies a type of data and a name, and must be

0 commit comments

Comments
 (0)