NatLabRockies / NatLabRockies/OpenStudio
Add ability to control the verbosity of the `OSRunner` method `registerXXX` for out OSW
Open
Nobody has claimed this yet.
component - logs and warnings
Enhancement Request
- Dominant language
- C++
- Stars
- 646
- Forks
- 237
- Avg merge
- 3d 11h
- Merged PRs (30d)
- 10
Description
Enhancement Request
Add ability to control the verbosity of the OSRunner method registerXXX (registerWarning, registerInfo). This will control what the WorkflowStepResult will contain, and in turn what the final out OSW will contain
Detailed Description
Possible Implementation
- Add a new OSRunner.setLogLevel.
- Add a new WOrkflowJSON key.
- Add a new CLI parameter
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing OSRunner's registerWarning and registerInfo methods and how their messages enter WorkflowStepResult and the final OSW output. Review the proposed OSRunner.setLogLevel, new WorkflowJSON key, and CLI parameter together; done means the verbosity setting consistently controls all three paths.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- api, cli
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100