From dadc355b060c63b87af947881b112c317af1e7c9 Mon Sep 17 00:00:00 2001 From: Christophe Bedard Date: Fri, 27 Dec 2019 14:17:13 -0500 Subject: [PATCH] Use imperative mood in constructor docstrings --- .../tracetools_analysis/data_model/cpu_time.py | 2 +- .../tracetools_analysis/data_model/profile.py | 2 +- .../tracetools_analysis/data_model/ros2.py | 2 +- .../tracetools_analysis/processor/__init__.py | 10 +++++----- .../tracetools_analysis/processor/cpu_time.py | 1 + .../tracetools_analysis/processor/profile.py | 2 +- .../tracetools_analysis/processor/ros2.py | 1 + .../tracetools_analysis/utils/__init__.py | 2 +- .../tracetools_analysis/utils/cpu_time.py | 2 +- .../tracetools_analysis/utils/profile.py | 2 +- tracetools_analysis/tracetools_analysis/utils/ros2.py | 2 +- 11 files changed, 15 insertions(+), 13 deletions(-) diff --git a/tracetools_analysis/tracetools_analysis/data_model/cpu_time.py b/tracetools_analysis/tracetools_analysis/data_model/cpu_time.py index f09b628..fafcdbf 100644 --- a/tracetools_analysis/tracetools_analysis/data_model/cpu_time.py +++ b/tracetools_analysis/tracetools_analysis/data_model/cpu_time.py @@ -27,7 +27,7 @@ class CpuTimeDataModel(DataModel): """ def __init__(self) -> None: - """Constructor.""" + """Create a CpuTimeDataModel.""" super().__init__() self.times = pd.DataFrame(columns=[ 'tid', diff --git a/tracetools_analysis/tracetools_analysis/data_model/profile.py b/tracetools_analysis/tracetools_analysis/data_model/profile.py index ff68b21..c7ce318 100644 --- a/tracetools_analysis/tracetools_analysis/data_model/profile.py +++ b/tracetools_analysis/tracetools_analysis/data_model/profile.py @@ -28,7 +28,7 @@ class ProfileDataModel(DataModel): """ def __init__(self) -> None: - """Constructor.""" + """Create a ProfileDataModel.""" super().__init__() self.times = pd.DataFrame(columns=[ 'tid', diff --git a/tracetools_analysis/tracetools_analysis/data_model/ros2.py b/tracetools_analysis/tracetools_analysis/data_model/ros2.py index 66f3cf5..70a80b9 100644 --- a/tracetools_analysis/tracetools_analysis/data_model/ros2.py +++ b/tracetools_analysis/tracetools_analysis/data_model/ros2.py @@ -27,7 +27,7 @@ class Ros2DataModel(DataModel): """ def __init__(self) -> None: - """Constructor.""" + """Create a Ros2DataModel.""" super().__init__() # Objects (one-time events, usually when something is created) self.contexts = pd.DataFrame(columns=['context_handle', diff --git a/tracetools_analysis/tracetools_analysis/processor/__init__.py b/tracetools_analysis/tracetools_analysis/processor/__init__.py index 7fee4a4..56d530a 100644 --- a/tracetools_analysis/tracetools_analysis/processor/__init__.py +++ b/tracetools_analysis/tracetools_analysis/processor/__init__.py @@ -40,7 +40,7 @@ class EventMetadata(): tid: int = None, ) -> None: """ - Constructor. + Create an EventMetadata. Parameters with a default value of `None` are not mandatory, since they are not always present. @@ -115,7 +115,7 @@ class EventHandler(Dependant): **kwargs, ) -> None: """ - Constructor. + Create an EventHandler. TODO make subclasses pass on their *DataModel to this class @@ -173,7 +173,7 @@ class DependencySolver(): **kwargs, ) -> None: """ - Constructor. + Create a DependencySolver. :param initial_dependants: the initial dependant instances, in order :param kwargs: the parameters to pass on to new instances @@ -251,7 +251,7 @@ class Processor(): **kwargs, ) -> None: """ - Constructor. + Create a Processor. :param handlers: the `EventHandler`s to use for processing :param kwargs: the parameters to pass on to new handlers @@ -368,7 +368,7 @@ class ProcessingProgressDisplay(): processing_elements: List[str], ) -> None: """ - Constructor. + Create a ProcessingProgressDisplay. :param processing_elements: the list of elements doing processing """ diff --git a/tracetools_analysis/tracetools_analysis/processor/cpu_time.py b/tracetools_analysis/tracetools_analysis/processor/cpu_time.py index 60d6fa5..2eb1698 100644 --- a/tracetools_analysis/tracetools_analysis/processor/cpu_time.py +++ b/tracetools_analysis/tracetools_analysis/processor/cpu_time.py @@ -34,6 +34,7 @@ class CpuTimeHandler(EventHandler): self, **kwargs, ) -> None: + """Create a CpuTimeHandler.""" # Link event to handling method handler_map = { 'sched_switch': diff --git a/tracetools_analysis/tracetools_analysis/processor/profile.py b/tracetools_analysis/tracetools_analysis/processor/profile.py index 437727e..fb3bdbd 100644 --- a/tracetools_analysis/tracetools_analysis/processor/profile.py +++ b/tracetools_analysis/tracetools_analysis/processor/profile.py @@ -47,7 +47,7 @@ class ProfileHandler(EventHandler): **kwargs, ) -> None: """ - Constructor. + Create a ProfileHandler. :param address_to_func: the mapping from function address (`int` or hex `str`) to name """ diff --git a/tracetools_analysis/tracetools_analysis/processor/ros2.py b/tracetools_analysis/tracetools_analysis/processor/ros2.py index 9daba18..fb8dc9d 100644 --- a/tracetools_analysis/tracetools_analysis/processor/ros2.py +++ b/tracetools_analysis/tracetools_analysis/processor/ros2.py @@ -34,6 +34,7 @@ class Ros2Handler(EventHandler): self, **kwargs, ) -> None: + """Create a Ros2Handler.""" # Link a ROS trace event to its corresponding handling method handler_map = { 'ros2:rcl_init': diff --git a/tracetools_analysis/tracetools_analysis/utils/__init__.py b/tracetools_analysis/tracetools_analysis/utils/__init__.py index e893466..3f30d52 100644 --- a/tracetools_analysis/tracetools_analysis/utils/__init__.py +++ b/tracetools_analysis/tracetools_analysis/utils/__init__.py @@ -35,7 +35,7 @@ class DataModelUtil(): data_model: DataModel, ) -> None: """ - Constructor. + Create a DataModelUtil. :param data_model: the data model """ diff --git a/tracetools_analysis/tracetools_analysis/utils/cpu_time.py b/tracetools_analysis/tracetools_analysis/utils/cpu_time.py index f2c60bf..68a234f 100644 --- a/tracetools_analysis/tracetools_analysis/utils/cpu_time.py +++ b/tracetools_analysis/tracetools_analysis/utils/cpu_time.py @@ -28,7 +28,7 @@ class CpuTimeDataModelUtil(DataModelUtil): data_model: CpuTimeDataModel, ) -> None: """ - Constructor. + Create a CpuTimeDataModelUtil. :param data_model: the data model object to use """ diff --git a/tracetools_analysis/tracetools_analysis/utils/profile.py b/tracetools_analysis/tracetools_analysis/utils/profile.py index 34d59d9..8389381 100644 --- a/tracetools_analysis/tracetools_analysis/utils/profile.py +++ b/tracetools_analysis/tracetools_analysis/utils/profile.py @@ -34,7 +34,7 @@ class ProfileDataModelUtil(DataModelUtil): data_model: ProfileDataModel, ) -> None: """ - Constructor. + Create a ProfileDataModelUtil. :param data_model: the data model object to use """ diff --git a/tracetools_analysis/tracetools_analysis/utils/ros2.py b/tracetools_analysis/tracetools_analysis/utils/ros2.py index 2af4899..a20c890 100644 --- a/tracetools_analysis/tracetools_analysis/utils/ros2.py +++ b/tracetools_analysis/tracetools_analysis/utils/ros2.py @@ -34,7 +34,7 @@ class Ros2DataModelUtil(DataModelUtil): data_model: Ros2DataModel, ) -> None: """ - Constructor. + Create a Ros2DataModelUtil. :param data_model: the data model object to use """