Python: Fix docs

Author: CouleeApps

python/renderlayer.py

@@ -52,13 +52,9 @@ def __getitem__(self, value):
 
 class BaseRenderLayer(metaclass=_RenderLayerMetaclass):
 	"""
-	RenderLayer is a plugin class that allows you to customize the presentation of
-	Linear and Graph view output, adding, changing, or removing lines before they are
-	presented in the UI.
-
-	BaseRenderLayer provides a lower-level interface for manipulating the graphs
-	and lines directly, whereas RenderLayer provides an interface where you can
-	choose to target a specific IL level or a couple different Linear View specific
+	BaseRenderLayer provides a lower-level interface for manipulating graphs
+	and lines directly, whereas :py:class:`RenderLayer` provides an interface where you
+	can choose to target a specific IL level or a couple different Linear View specific
 	line constructs.
 	"""
 
@@ -92,7 +88,7 @@ def register(cls):
 		cls._registered_layers.append(layer)
 
 	def __eq__(self, other):
-		if not isinstance(other, RenderLayer):
+		if not isinstance(other, BaseRenderLayer):
 			return False
 		return self.name == other.name
 
@@ -250,7 +246,7 @@ def apply_to_low_level_il_block(
 		Subclasses should modify the input `lines` list to make modifications to
 		the presentation of the block.
 
-		.. note:: This function will only handle Lifted IL/LLIL/LLIL(SSA) lines.
+		.. note:: This function will only handle Lifted IL/LLIL/LLIL(SSA) lines. \
 		You can use the block's `function_graph_type` property to determine which is being handled.
 
 		:param block: Basic Block containing those lines
@@ -268,7 +264,7 @@ def apply_to_medium_level_il_block(
 		Subclasses should modify the input `lines` list to make modifications to
 		the presentation of the block.
 
-		.. note:: This function will only handle MLIL/MLIL(SSA)/Mapped MLIL/Mapped MLIL(SSA) lines.
+		.. note:: This function will only handle MLIL/MLIL(SSA)/Mapped MLIL/Mapped MLIL(SSA) lines. \
 		You can use the block's `function_graph_type` property to determine which is being handled.
 
 		:param block: Basic Block containing those lines
@@ -286,11 +282,11 @@ def apply_to_high_level_il_block(
 		Subclasses should modify the input `lines` list to make modifications to
 		the presentation of the block.
 
-		.. note:: This function will only handle HLIL/HLIL(SSA)/Language Representation lines.
+		.. note:: This function will only handle HLIL/HLIL(SSA)/Language Representation lines. \
 		You can use the block's `function_graph_type` property to determine which is being handled.
 
-		.. warning:: This function will NOT apply to High Level IL bodies as displayed
-		in Linear View! Those are handled by `apply_to_hlil_body` instead as they
+		.. warning:: This function will NOT apply to High Level IL bodies as displayed \
+		in Linear View! Those are handled by `apply_to_hlil_body` instead as they \
 		do not have a Basic Block associated with them.
 
 		:param block: Basic Block containing those lines
@@ -308,8 +304,8 @@ def apply_to_hlil_body(
 		Subclasses should modify the input `lines` list to make modifications to
 		the presentation of the function.
 
-		.. warning:: This function only applies to Linear View, and not to Graph View!
-		If you want to handle Graph View too, you will need to use `apply_to_high_level_il_block`
+		.. warning:: This function only applies to Linear View, and not to Graph View! \
+		If you want to handle Graph View too, you will need to use `apply_to_high_level_il_block` \
 		and handle the lines one block at a time.
 
 		:param function: Function containing those lines
@@ -342,7 +338,11 @@ def apply_to_block(
 			lines: List['binaryninja.DisassemblyTextLine'],
 	):
 		"""
+		Apply to lines generated by a Basic Block, of any type. If not overriden, this
+		function will call the appropriate apply_to_X_level_il_block function.
 
+		:param block: Basic Block containing those lines
+		:param lines: Lines of text for the block, to be modified by this function
 		"""
 		if not block.is_il:
 			self.apply_to_disassembly_block(block, lines)
@@ -357,6 +357,13 @@ def apply_to_block(
 			pass
 
 	def apply_to_flow_graph(self, graph: 'binaryninja.FlowGraph') -> None:
+		"""
+		Overridden from BaseRenderLayer to provide more specific callbacks. Check
+		:py:func:`BaseRenderLayer.apply_to_flow_graph` in case you want to
+		override this directly.
+
+		:param graph: Graph to modify
+		"""
 		for i, node in enumerate(graph.nodes):
 			lines = node.lines
 			if node.basic_block is not None and isinstance(node.basic_block, binaryninja.BasicBlock):
@@ -370,6 +377,17 @@ def apply_to_linear_view_object(
 			next: Optional['binaryninja.LinearViewObject'],
 			lines: List['binaryninja.LinearDisassemblyLine']
 	) -> List['binaryninja.LinearDisassemblyLine']:
+		"""
+		Overridden from BaseRenderLayer to provide more specific callbacks. Check
+		:py:func:`BaseRenderLayer.apply_to_linear_view_object` in case you want to
+		override this directly.
+
+		:param obj: Linear View Object being rendered
+		:param prev: Linear View Object located directly above this one
+		:param next: Linear View Object located directly below this one
+		:param lines: Lines originally rendered by the Linear View Object
+		:return: Updated set of lines to display in Linear View
+		"""
 		# Hack: HLIL bodies don't have basic blocks
 		if obj.identifier.name == "Body":
 			self.apply_to_hlil_body(lines[0].function, lines)