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.
Removed the 'enabled' attribute from the class docstring.
@blnicho
Copy link
Member

blnicho commented Dec 9, 2025

@Somesh-Kennedy we discussed this at the dev call and decided to close this without merging. We don't think documenting a private attribute in an untested example script meets the minimum threshold of "usefulness" we expect from PRs. If you disagree with our decision please reach out or leave a comment.

@blnicho blnicho closed this Dec 9, 2025
@github-project-automation github-project-automation bot moved this from Todo to Done in Pyomo 6.10 Dec 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Done

Development

Successfully merging this pull request may close these issues.

3 participants