Skip to content

Commit

Permalink
Updated header and _header descriptions in docstrings.
Browse files Browse the repository at this point in the history
  • Loading branch information
asgibson committed Dec 18, 2024
1 parent ef40520 commit e5061d8
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions onair/src/ai_components/ai_plugin_abstract/ai_plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,8 @@ class AIPlugin(ABC):
component_name : str
Name given to instance of plugin.
headers : list of str
Names for each data point in the OnAIR data frame.
Names for each data point, corresponding to the OnAIR low_level_data and frame
elements by matching index position.
"""

def __init__(self, _name: str, _headers: list):
Expand All @@ -50,7 +51,7 @@ def __init__(self, _name: str, _headers: list):
_name : str
The name of this plugin instance.
_headers : list of str
Sequenced names of each item in OnAIR data frame.
Sequenced list of names for each item in OnAIR low_level_data and frame.
"""
assert len(_headers) > 0
self.component_name = _name
Expand Down

0 comments on commit e5061d8

Please sign in to comment.