Skip to content

Conversation

@Somesh-Kennedy
Copy link

Fixes # .

Added docstring (enhanced the comment) for TimingHandler class, detailing attributes and example data structure.

Summary/Motivation:

Increasing the understandability of the code (for the whole TimingHandler class)

Changes proposed in this PR:

  • added an example attribute in the comment in order to understand the returned object.

Legal Acknowledgement

By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution:

  1. I agree my contributions are submitted under the BSD license.
  2. I represent I am authorized to make the contributions and grant the license. If my employer has rights to intellectual property that includes these contributions, I represent that I have received permission to make contributions and grant the required license on behalf of that employer.

Added docstring for TimingHandler class, detailing attributes and example data structure.
Attributes:
_testRecord (OrderedDict): Current test's timing data collection
enabled (bool): Flag to enable/disable timing collection
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was looking over the class to make sure these changes are accurate, and I think enabled doesn't actually do anything. It's set in __init__ but... then is never used again. Which leads me to believe that maybe we should just remove enabled (and this line from the docs).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants